{ "openapi": "3.0.0", "externalDocs": { "description": "See documentation for Akamai's Edge Diagnostics API", "url": "https://techdocs.akamai.com/edge-diagnostics/reference" }, "info": { "title": "Akamai: Edge Diagnostics API", "version": "v1", "license": { "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" } }, "paths": { "/connectivity-problems": { "post": { "description": "Launches an [asynchronous](https://techdocs.akamai.com/edge-diagnostics/reference/asynchronous-processes) request to simultaneously run [Launch a GREP request](https://techdocs.akamai.com/edge-diagnostics/reference/post-grep), [Request content with cURL](https://techdocs.akamai.com/edge-diagnostics/reference/post-curl), and [Test network connectivity with MTR](https://techdocs.akamai.com/edge-diagnostics/reference/post-mtr) operations for a URL. It may help you diagnose issues with slow download and high response time. Successful operations return fetched GREP, cURL, and MTR data.", "operationId": "post-connectivity-problems", "summary": "Run the connectivity problems scenario", "tags": [ "Connectivity problems" ], "externalDocs": { "description": "See documentation for this operation in Akamai's Edge Diagnostics API", "url": "https://techdocs.akamai.com/edge-diagnostics/reference/post-connectivity-problems" }, "requestBody": { "content": { "application/json": { "example": { "clientIp": "192.0.2.15", "edgeLocationId": "allen-tx-unitedregionCodes", "ipVersion": "IPV4", "packetType": "TCP", "port": 80, "spoofEdgeIp": "192.0.2.9", "url": "http://www.atcuser15.akamaiu.com", "requestHeaders": [ "Accept-Language: en-US" ] }, "schema": { "additionalProperties": false, "description": "Collects data to use in the Connectivity problems scenario request.", "type": "object", "required": [ "url" ], "properties": { "clientIp": { "description": "Client IP for the Connectivity problems scenario to start MTR from. You can use the `ip` value from the `edgeIps` array in the [collected diagnostic data](https://techdocs.akamai.com/edge-diagnostics/reference/get-user-diagnostic-data-group-records).", "example": "{{clientIp}}", "minLength": 1, "type": "string" }, "edgeLocationId": { "description": "Unique identifier for an edge server location closest to end users experiencing issues with the URL. Run the [List available edge server locations](https://techdocs.akamai.com/edge-diagnostics/reference/get-edge-locations) operation to get this value.", "example": "{{edgeLocationId}}", "minLength": 1, "type": "string" }, "ipVersion": { "description": "IP version for the Connectivity problems scenario to use to run cURL and MTR commands, either `IPV4` or `IPV6`.", "example": "{{ipVersion}}", "type": "string", "enum": [ "IPV4", "IPV6" ] }, "packetType": { "description": "Packet type for the Connectivity problems scenario to use to run MTR, either `ICMP` or `TCP`.", "example": "{{packetType}}", "type": "string", "enum": [ "ICMP", "TCP" ] }, "port": { "description": "Port number for the Connectivity problems scenario to use to run MTR, either `80` or `443`.", "example": "{{port}}", "type": "integer", "enum": [ 80, 443 ] }, "requestHeaders": { "description": "Customized headers for the `curl` request in the format `header: value`. The request includes [Akamai Pragma headers](https://techdocs.akamai.com/edge-diagnostics/docs/pragma-headers) by default.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } }, "runFromSiteShield": { "description": "Runs Connectivity problems from a Site Shield map. To learn more, check [Site Shield requests](https://techdocs.akamai.com/edge-diagnostics/reference/site-shield-requests).", "example": "{{runFromSiteShield}}", "type": "boolean" }, "sensitiveRequestHeaderKeys": { "description": "Sensitive `requestHeaders` you don't want to store in the database after running the request. Check [Sensitive headers](https://techdocs.akamai.com/edge-diagnostics/reference/sensitive-headers) to see the list of request headers treated as sensitive by default.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } }, "spoofEdgeIp": { "description": "IP of the edge server you want to serve traffic from. You can use the `ip` value from the `edgeIps` array in the [collected diagnostic data](https://techdocs.akamai.com/edge-diagnostics/reference/get-user-diagnostic-data-group-records).", "example": "{{spoofEdgeIp}}", "minLength": 1, "type": "string" }, "url": { "description": "URL you want to run the Connectivity problems scenario for.", "example": "{{url}}", "format": "uri", "type": "string" } }, "x-akamai": { "file-path": "schemas/connectivityProblemsRequest.yaml" } } } } }, "responses": { "202": { "description": "Process successfully launched.", "content": { "application/json": { "example": { "createdBy": "szhang", "createdTime": "2021-09-29T03:56:01Z", "executionStatus": "SUCCESS", "internalIp": "192.0.2.5", "requestId": 181, "clientIpLocation": { "asNumber": 9583, "city": "BANGALORE", "countryCode": "IN", "regionCode": "KA" }, "internalIpLocation": { "asNumber": 20940, "city": "ASHBURN", "countryCode": "US", "regionCode": "VA" }, "request": { "clientIp": "2001:db8::4", "edgeLocationId": "allen-tx-unitedregionCodes", "ipVersion": "IPV6", "packetType": "ICMP", "port": 443, "spoofEdgeIp": "192.0.2.9", "url": "http://www.atcuser15.akamaiu.com", "requestHeaders": [ "X-Location: NGDT" ] }, "spoofEdgeIpLocation": { "asNumber": 20940, "city": "MUMBAI", "countryCode": "IN", "regionCode": "MH" }, "summary": { "connectivity": [ { "destinationContext": "CLIENT_IP", "executionContext": "EDGE_IP_TO_CLIENT_IP", "executionStatus": "SUCCESS", "sourceContext": "EDGE_IP_BASED_ON_LOCATION", "suggestedActions": [ "Look for a packet loss or sudden jumps in the hop time.", "For a loss or latency within the end user ISP network, ask the end user to contact thier ISP.", "For a loss or latency within Akamai network, contact Akamai Technical Support.", "If a packet loss occurs at one hop but does not propogate to the end of the trace, it is irrelevant." ], "additionalRequestParameters": { "destination": "2001:db8::4", "source": "192.0.2.180" }, "destinationIpLocation": { "asNumber": 9583, "city": "BANGALORE", "countryCode": "IN", "regionCode": "KA" }, "result": { "host": "a23-50-51-236.deploy.akamaitechnologies.com", "hops": [ { "averageLatency": 0, "bestRtt": 0, "host": "???", "lastPacketLatency": 0, "number": 7, "packetLoss": 100, "sentPackets": 10, "standardDeviation": 0, "worstRtt": 0 }, { "averageLatency": 323.7, "bestRtt": 226.9, "ip": "2001:db8:7d7d:ecb6:37db:23d8:ba87:c20a", "lastPacketLatency": 408.5, "number": 5, "packetLoss": 20, "sentPackets": 10, "standardDeviation": 103.5, "worstRtt": 426.2, "ipLocation": { "asNumber": 9498, "city": "BANGALORE", "countryCode": "IN", "regionCode": "KA" } } ] }, "sourceIpLocation": { "asNumber": 20940, "city": "ASHBURN", "countryCode": "US", "regionCode": "VA" } }, { "destinationContext": "ORIGIN_IP", "executionContext": "EDGE_IP_TO_ORIGIN_IP", "executionStatus": "SUCCESS", "sourceContext": "EDGE_IP_CONNECTED_TO_ORIGIN", "suggestedActions": [ "Look for a packet loss or sudden jumps in the hop time.", "For a loss or latency within the end user ISP network, ask the end user to contact thier ISP.", "For a loss or latency within Akamai network, contact Akamai Technical Support.", "If a packet loss occurs at one hop but does not propogate to the end of the trace, it is irrelevant." ], "additionalRequestParameters": { "destination": "2001:db8:c1da:b02:dd93:cdd:47e6:616a", "source": "192.0.2.14" }, "destinationIpLocation": { "asNumber": 20940, "city": "ASHBURN", "countryCode": "US", "regionCode": "VA" }, "result": { "host": "a23-212-50-38.deploy.akamaitechnologies.com", "hops": [ { "averageLatency": 8577, "bestRtt": 7550, "host": "ae0.tata-bom3.netarch.akamai.com", "ip": "2001:db8:bf88:bbbf:7619:594b:8d9a:4c88", "lastPacketLatency": 7550, "number": 1, "packetLoss": 60, "sentPackets": 10, "standardDeviation": 956.9, "worstRtt": 9749, "ipLocation": { "asNumber": 20940, "city": "MUMBAI", "countryCode": "IN", "regionCode": "MH" } } ] }, "sourceIpLocation": { "asNumber": 20940, "city": "MUMBAI", "countryCode": "IN", "regionCode": "MH" } } ], "content": [ { "executionContext": "DEFAULT", "executionStatus": "SUCCESS", "suggestedActions": [ "Compare the response headers served from edge and origin.", "Check for content correctness.", "Check content length/bytes served." ], "additionalRequestParameters": { "requestHeaders": [ "Pragma: akamai-x-cache-on, akamai-x-cache-remote-on, akamai-x-check-cacheable, akamai-x-get-true-cache-key, akamai-x-get-cache-key, akamai-x-serial-no, akamai-x-get-request-id" ] }, "result": { "responseHeaderList": [ "Last-Modified: Thu, 12 Feb 2015 15:44:28 GMT", "Content-Length: 15051" ] } } ], "logLines": [ { "executionContext": "DEFAULT", "executionStatus": "SUCCESS", "suggestedActions": [ "Check for long times.", "Check content length/bytes served." ], "result": { "legend": { "fObjectStatus": { "D": "A default object was served.", "a": "This response was sent through the ESI processor.", "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." }, "fObjectStatus2": {}, "fObjectStatus3": {}, "logType": { "f": "(f) going forward to forward hostname" }, "rObjectStatus": {}, "rObjectStatus2": {}, "rObjectStatus3": {} }, "logs": [ { "clientIp": "192.0.2.5", "contentBytesServed": "-", "edgeIp": "192.0.2.14", "forwardIp": "192.0.2.15", "logType": "f", "objectStatus": "oaDx", "timeTaken": "0", "turnaroundTime": "268" } ] } } ] }, "connectivity": [ { "destinationContext": "ORIGIN_IP", "executionContext": "EDGE_IP_TO_ORIGIN_IP", "executionStatus": "SUCCESS", "sourceContext": "EDGE_IP_CONNECTED_TO_ORIGIN", "suggestedActions": [ "Look for a packet loss or sudden jumps in the hop time.", "For a loss or latency within the end user ISP network, ask the end user to contact thier ISP.", "For a loss or latency within Akamai network, contact Akamai Technical Support.", "If a packet loss occurs at one hop but does not propogate to the end of the trace, it is irrelevant.", "If source Ip country and destination IP country is same then there should not be any hops outside the country." ], "additionalRequestParameters": { "destination": "2001:db8:82cf:7edc:4ec:d25f:34ed:8058", "source": "192.0.2.14" }, "destinationIpLocation": { "asNumber": 20940, "city": "ASHBURN", "countryCode": "US", "regionCode": "VA" }, "result": { "averageLatency": 200.3, "host": "a23-212-50-38.deploy.akamaitechnologies.com", "packetLoss": 0, "result": "Start: 2021-09-29T03:56:40+0000\nHOST: a23-212-50-38.deploy.akamaitechnologies.com Loss% Snt Last Avg Best Wrst StDev\n 1.|-- ae0.tata-bom3.netarch.akamai.com (2600:140f:4::1) 60.0% 10 7550. 8577. 7550. 9749. 956.9\n 2.|-- 2403:0:100::911 0.0% 10 0.5 0.6 0.3 2.8 0.8\n 3.|-- if-ae-1-101.tcore2.mlv-mumbai.ipv6.as6453.net (2001:db8::c) 0.0% 10 0.4 4.4 0.3 37.5 11.6\n 4.|-- if-ae-12-2.tcore1.l78-london.ipv6.as6453.net (2001:db8::d) 0.0% 10 128.4 128.4 128.2 129.0 0.2\n 5.|-- if-ae-15-2.tcore3.njy-newark.ipv6.as6453.net (2001:db8::e) 0.0% 10 199.5 199.5 199.4 199.7 0.1\n 6.|-- if-ae-1-3.tcore4.njy-newark.ipv6.as6453.net (2001:db8::b) 0.0% 10 199.3 205.2 199.2 227.7 10.0\n 7.|-- if-ae-12-2.tcore3.aeq-ashburn.ipv6.as6453.net (2001:db8::b) 0.0% 10 204.3 204.4 204.2 204.6 0.1\n 8.|-- 2001:5a0:600:502::2 0.0% 10 204.3 204.3 204.2 204.4 0.0\n 9.|-- ae1.r01.iad01.icn.netarch.akamai.com (2600:1488:a180:125::a) 0.0% 10 215.6 214.2 204.5 262.8 17.6\n 10.|-- ae3.r01.iad03.icn.netarch.akamai.com (2600:1488:5fc3:4d::b) 0.0% 10 213.3 206.9 204.4 213.3 3.3\n 11.|-- ae21.r02.iad03.ien.netarch.akamai.com (2600:1488:a181:211::b) 0.0% 10 218.4 206.3 200.1 227.5 9.8\n 12.|-- ae3.ctl-iad4.netarch.akamai.com (2600:1488:a181:205::b) 0.0% 10 205.0 240.7 204.8 382.7 68.8\n 13.|-- g2600-1408-7400-0000-0000-0000-17c7-3f1b.deploy.static.akamaitechnologies.com (2 0.0% 10 200.3 200.3 200.3 200.6 0.1", "startTime": 1632887800, "hops": [ { "averageLatency": 8577, "bestRtt": 7550, "host": "ae0.tata-bom3.netarch.akamai.com", "ip": "2001:db8:a8ef:a1dc:8236:58f5:9096:1efc", "lastPacketLatency": 7550, "number": 1, "packetLoss": 60, "sentPackets": 10, "standardDeviation": 956.9, "worstRtt": 9749, "ipLocation": { "asNumber": 20940, "city": "MUMBAI", "countryCode": "IN", "regionCode": "MH" } }, { "averageLatency": 200.3, "bestRtt": 200.3, "host": "g2600-1408-7400-0000-0000-0000-17c7-3f1b.deploy.static.akamaitechnologies.com", "lastPacketLatency": 200.3, "number": 2, "packetLoss": 0, "sentPackets": 10, "standardDeviation": 0.1, "worstRtt": 200.6 } ] }, "sourceIpLocation": { "asNumber": 20940, "city": "MUMBAI", "countryCode": "IN", "regionCode": "MH" } }, { "destinationContext": "CLIENT_IP", "executionContext": "EDGE_IP_TO_CLIENT_IP", "executionStatus": "SUCCESS", "sourceContext": "EDGE_IP_BASED_ON_LOCATION", "suggestedActions": [ "Look for a packet loss or sudden jumps in the hop time.", "For a loss or latency within the end user ISP network, ask the end user to contact thier ISP.", "For a loss or latency within Akamai network, contact Akamai Technical Support.", "If a packet loss occurs at one hop but does not propogate to the end of the trace, it is irrelevant.", "If source Ip country and destination IP country is same then there should not be any hops outside the country." ], "additionalRequestParameters": { "destination": "2001:db8::4", "source": "192.0.2.245" }, "destinationIpLocation": { "asNumber": 9583, "city": "BANGALORE", "countryCode": "IN", "regionCode": "KA" }, "result": { "averageLatency": 0, "host": "a23-50-51-236.deploy.akamaitechnologies.com", "packetLoss": 100, "result": "Start: 2021-09-29T03:56:18+0000\nHOST: a23-50-51-236.deploy.akamaitechnologies.com Loss% Snt Last Avg Best Wrst StDev\n 1.|-- ae0.cyrusone-iad2.netarch.akamai.com (2600:1408:24::1) 0.0% 10 22.6 29.4 7.2 96.5 26.3\n 2.|-- ae0-86.cr2-was1.ip6.gtt.net (2001:668:0:3:ffff:0:45ae:1189) 0.0% 10 0.5 4.7 0.3 36.6 11.4\n 3.|-- 2001:668:0:2:ffff:0:5995:8dd5 0.0% 10 74.4 79.2 73.5 96.1 8.9\n 4.|-- 2001:668:0:3:ffff:0:4d43:50be 0.0% 10 71.4 73.1 70.9 89.6 5.8\n 5.|-- 2404:a800::60 20.0% 10 408.5 323.7 226.9 426.2 103.5\n 6.|-- 2404:a800:3a00::1ba 0.0% 10 227.5 227.6 227.5 227.8 0.1\n 7.|-- ??? 100.0 10 0.0 0.0 0.0 0.0 0.0", "startTime": 1632887778, "hops": [ { "averageLatency": 29.4, "bestRtt": 7.2, "host": "ae0.cyrusone-iad2.netarch.akamai.com", "ip": "2001:db8:8c70:51d:d8d6:7dc0:caa6:97ef", "lastPacketLatency": 22.6, "number": 1, "packetLoss": 0, "sentPackets": 10, "standardDeviation": 26.3, "worstRtt": 96.5, "ipLocation": { "asNumber": 20940, "city": "ASHBURN", "countryCode": "US", "regionCode": "VA" } }, { "averageLatency": 0, "bestRtt": 0, "host": "???", "lastPacketLatency": 0, "number": 2, "packetLoss": 100, "sentPackets": 10, "standardDeviation": 0, "worstRtt": 0 } ] }, "sourceIpLocation": { "asNumber": 20940, "city": "ASHBURN", "countryCode": "US", "regionCode": "VA" } } ], "content": [ { "executionContext": "DEFAULT", "executionStatus": "SUCCESS", "suggestedActions": [ "Compare the response headers served from edge and origin.", "Check for content correctness.", "Check content length/bytes served." ], "additionalRequestParameters": { "requestHeaders": [ "Pragma: akamai-x-cache-on, akamai-x-cache-remote-on, akamai-x-check-cacheable, akamai-x-get-true-cache-key, akamai-x-get-cache-key, akamai-x-serial-no, akamai-x-get-request-id" ] }, "result": { "httpStatusCode": 200, "httpVersion": "HTTP/1.1", "reasonPhrase": "OK", "responseHeaderList": [ "X-Cache: TCP_MISS from a23-212-50-38.deploy.akamaitechnologies.com (AkamaiGHost/10.4.4-34537092) (-)", "X-True-Cache-Key: /D/000/akamaiflowershop.com/ vcd=1456", "Content-Length: 15051", "Content-Type: text/html" ], "timing": { "dnsLookupTime": 1.509502, "sslConnectionTime": 0, "tcpConnectionTime": 1.524193, "timeToFirstByte": 1.555875, "totalTime": 2.091051 } } } ], "logLines": [ { "executionContext": "DEFAULT", "executionStatus": "SUCCESS", "suggestedActions": [ "Check for long times.", "Check content length/bytes served." ], "result": { "legend": { "fObjectStatus": { "D": "A default object was served.", "a": "This response was sent through the ESI processor.", "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." }, "fObjectStatus2": {}, "fObjectStatus3": {}, "logType": { "f": "(f) going forward to forward hostname" }, "rObjectStatus": {}, "rObjectStatus2": {}, "rObjectStatus3": {} }, "logs": [ { "arl": "/D/16382/1234567/000/akamaiflowershop.com/", "bytesReceived": "3980", "bytesServed": "-", "clientIp": "192.0.2.5", "contentBytesServed": "-", "contentType": "text/html", "cookie": "-", "cpCode": "1234567", "dateTime": "2021-09-29T03:56:05.609Z", "edgeIp": "192.0.2.14", "error": "-", "forwardIp": "192.0.2.15", "hostHeader": "-", "httpMethod": "GET", "httpStatus": "200", "logType": "f", "objectSize": "-", "objectStatus": "oaDx", "objectStatus2": "-", "objectStatus3": "-", "referer": "-", "sslVersion": "-", "timeTaken": "0", "turnaroundTime": "268", "userAgent": "-" } ] } } ] }, "schema": { "additionalProperties": false, "description": "Collects the Connectivity problems scenario results and details about the request.", "type": "object", "required": [ "createdBy", "createdTime", "executionStatus", "internalIp", "internalIpLocation", "request", "requestId", "summary", "content", "connectivity", "logLines" ], "properties": { "clientIpLocation": { "additionalProperties": false, "description": "Specifies the geolocation of the Client IP.", "type": "object", "required": [ "city", "regionCode", "countryCode", "asNumber" ], "properties": { "asNumber": { "description": "Autonomous System Number the edge IP maps to.", "minimum": 0, "type": "integer" }, "city": { "description": "Closest city within a 50-mile radius the edge IP maps to.", "minLength": 1, "type": "string" }, "countryCode": { "description": "ISO 3166 country code the edge IP maps to.", "minLength": 1, "type": "string" }, "regionCode": { "description": "ISO 3166 region code the edge IP maps to.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/edgeIpLocation.yaml" } }, "connectivity": { "description": "Lists the results of the MTR request.", "minItems": 1, "type": "array", "items": { "additionalProperties": false, "type": "object", "required": [ "executionStatus", "sourceIpLocation", "destinationIpLocation", "sourceContext", "destinationContext", "executionContext" ], "properties": { "additionalRequestParameters": { "additionalProperties": false, "description": "Specifies the MTR request.", "minProperties": 1, "type": "object", "required": [ "source", "destination" ], "properties": { "destination": { "description": "Destination of the request.", "minLength": 1, "type": "string" }, "ipVersion": { "description": "IP version used by the request, either `IPV4` or `IPV6`.", "type": "string", "enum": [ "IPV4", "IPV6" ] }, "packetType": { "description": "Packet type used by the request, either `ICMP` or `TCP`.", "type": "string", "enum": [ "ICMP", "TCP" ] }, "port": { "description": "Port number used by the request, either `80` or `443`.", "type": "integer", "enum": [ 80, 443 ] }, "source": { "description": "Source of the request.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/additionalMtrRequestParameters.yaml" } }, "destinationContext": { "description": "Whether the destination IP is a `CLIENT_IP` or `ORIGIN_IP`.", "type": "string", "enum": [ "ORIGIN_IP", "CLIENT_IP" ] }, "destinationIpLocation": { "additionalProperties": false, "description": "Specifies the geolocation of the origin server IP.", "type": "object", "required": [ "city", "regionCode", "countryCode", "asNumber" ], "properties": { "asNumber": { "description": "Autonomous System Number the edge IP maps to.", "minimum": 0, "type": "integer" }, "city": { "description": "Closest city within a 50-mile radius the edge IP maps to.", "minLength": 1, "type": "string" }, "countryCode": { "description": "ISO 3166 country code the edge IP maps to.", "minLength": 1, "type": "string" }, "regionCode": { "description": "ISO 3166 region code the edge IP maps to.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/edgeIpLocation.yaml" } }, "errorResponse": { "additionalProperties": false, "description": "Specifies the reason for `FAILURE` status.", "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Details about the error.", "minLength": 1, "type": "string" }, "errors": { "description": "Collects information about problems occurred while fetching the data.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } }, "status": { "description": "Error status code.", "minLength": 1, "type": "string" }, "title": { "description": "Error title.", "minLength": 1, "type": "string" }, "type": { "description": "Error type.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/errorResponse.yaml" } }, "executionContext": { "description": "Execution context for MTR. Edge Diagnostics executes MTR between an edge server and the origin server (`EDGE_IP_TO_ORIGIN_IP`) or, if a client IP is present in the request, between an edge server and the client machine (`EDGE_IP_TO_CLIENT_IP`).", "type": "string", "enum": [ "EDGE_IP_TO_ORIGIN_IP", "EDGE_IP_TO_CLIENT_IP" ] }, "executionStatus": { "description": "Status of the MTR request's execution. Possible values are `SUCCESS`, `FAILURE`, or `NOT_EXECUTED`. The `info` member and `FAILURE` in `errorResponse` provide details for `NOT_EXECUTED`.", "type": "string", "enum": [ "SUCCESS", "FAILURE", "NOT_EXECUTED" ] }, "info": { "additionalProperties": false, "description": "Specifies the reason for `NOT_EXECUTED` status.", "type": "object", "required": [ "key", "message" ], "properties": { "key": { "description": "Error key.", "minLength": 1, "type": "string" }, "message": { "description": "Details about the error.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/info.yaml" } }, "result": { "additionalProperties": false, "description": "Standard MTR results.", "type": "object", "required": [ "startTime", "host", "packetLoss", "averageLatency", "hops", "result" ], "properties": { "averageLatency": { "description": "Average latency for all hops, in seconds.", "minimum": 0, "type": "number" }, "hops": { "description": "Lists network hops with their data.", "minItems": 0, "type": "array", "items": { "additionalProperties": false, "description": "Collects network hops with their data.", "type": "object", "required": [ "number", "host", "ip", "ipLocation", "packetLoss", "sentPackets", "lastPacketLatency", "averageLatency", "bestRtt", "worstRtt", "standardDeviation" ], "properties": { "averageLatency": { "description": "Average hop value, useful to detect ongoing problems.", "minimum": 0, "type": "number" }, "bestRtt": { "description": "Fastest time, in milliseconds.", "minimum": 0, "type": "number" }, "host": { "description": "Host or domain name for the hop.", "minLength": 1, "type": "string" }, "ip": { "description": "IP of the hop's `edgeHost`.", "minLength": 1, "type": "string" }, "ipLocation": { "additionalProperties": false, "description": "Geolocation data for the hop's `edgeHost`.", "type": "object", "required": [ "city", "regionCode", "countryCode", "asNumber" ], "properties": { "asNumber": { "description": "Autonomous System Number the edge IP maps to.", "minimum": 0, "type": "integer" }, "city": { "description": "Closest city within a 50-mile radius the edge IP maps to.", "minLength": 1, "type": "string" }, "countryCode": { "description": "ISO 3166 country code the edge IP maps to.", "minLength": 1, "type": "string" }, "regionCode": { "description": "ISO 3166 region code the edge IP maps to.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/edgeIpLocation.yaml" } }, "lastPacketLatency": { "description": "Last measured hop value, useful to detect ongoing problems.", "minimum": 0, "type": "number" }, "number": { "description": "Index for each hop's count within the full set.", "minimum": 0, "type": "integer" }, "packetLoss": { "description": "Percentage of packets lost for the hop, maximum `100`.", "maximum": 100, "minimum": 0, "type": "number" }, "sentPackets": { "description": "Number of packets sent for the hop.", "minimum": 0, "type": "integer" }, "standardDeviation": { "description": "Standard deviation, in milliseconds.", "minimum": 0, "type": "number" }, "worstRtt": { "description": "Slowest time, in milliseconds.", "minimum": 0, "type": "number" } }, "x-akamai": { "file-path": "schemas/mtrHopInstance.yaml" } } }, "host": { "description": "Hostname within the edge network that corresponds to the `source` IP address.", "format": "hostname", "type": "string" }, "packetLoss": { "description": "Percentage of packets lost, maximum `100`.", "maximum": 100, "minimum": 0, "type": "number" }, "result": { "description": "Raw MTR utility output.", "minLength": 1, "type": "string" }, "startTime": { "description": "Epoch timestamp marking when MTR was run.", "type": "integer" } }, "x-akamai": { "file-path": "schemas/mtrData.yaml" } }, "sourceContext": { "description": "Context for MTR source. The source can be either an edge server forwarding the request to the origin server (`EDGE_IP_CONNECTED_TO_ORIGIN`) or an edge server in the location (`EDGE_IP_BASED_ON_LOCATION`), either selected randomly or provided in the request.", "type": "string", "enum": [ "EDGE_IP_CONNECTED_TO_ORIGIN", "EDGE_IP_BASED_ON_LOCATION" ] }, "sourceIpLocation": { "additionalProperties": false, "description": "Specifies the geolocation of the source IP.", "type": "object", "required": [ "city", "regionCode", "countryCode", "asNumber" ], "properties": { "asNumber": { "description": "Autonomous System Number the edge IP maps to.", "minimum": 0, "type": "integer" }, "city": { "description": "Closest city within a 50-mile radius the edge IP maps to.", "minLength": 1, "type": "string" }, "countryCode": { "description": "ISO 3166 country code the edge IP maps to.", "minLength": 1, "type": "string" }, "regionCode": { "description": "ISO 3166 region code the edge IP maps to.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/edgeIpLocation.yaml" } }, "suggestedActions": { "description": "Suggestions on what to do next with the results.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } } }, "x-akamai": { "file-path": "schemas/connectivity.yaml" } } }, "content": { "description": "Lists the results of the cURL request.", "minItems": 1, "type": "array", "items": { "additionalProperties": false, "type": "object", "required": [ "executionContext", "executionStatus" ], "properties": { "additionalRequestParameters": { "additionalProperties": false, "description": "Specifies the cURL request.", "minProperties": 1, "type": "object", "properties": { "includeDefaultPragmaHeaders": { "description": "Indicates whether the request included the default list of `Pragma` headers. Check [Pragma headers](https://techdocs.akamai.com/edge-diagnostics/docs/pragma-headers) to learn about default Akamai Pragma headers.", "type": "boolean" }, "ipVersion": { "description": "IP version used by the request, either `IPV4` or `IPV6`.", "type": "string", "enum": [ "IPV4", "IPV6" ] }, "requestHeaders": { "description": "Customized headers for `curl` request in the format `header: value`.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } } }, "x-akamai": { "file-path": "schemas/additionalCurlRequestParameters.yaml" } }, "errorResponse": { "additionalProperties": false, "description": "Specifies the reason for `FAILURE` status.", "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Details about the error.", "minLength": 1, "type": "string" }, "errors": { "description": "Collects information about problems occurred while fetching the data.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } }, "status": { "description": "Error status code.", "minLength": 1, "type": "string" }, "title": { "description": "Error title.", "minLength": 1, "type": "string" }, "type": { "description": "Error type.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/errorResponse.yaml" } }, "executionContext": { "description": "Execution context. The only possible value is `DEFAULT`. For now, this member doesn't provide any meaningful data.", "type": "string", "enum": [ "DEFAULT" ] }, "executionStatus": { "description": "Status of the cURL request's execution, either `SUCCESS` or `FAILURE`.", "type": "string", "enum": [ "SUCCESS", "FAILURE" ] }, "result": { "additionalProperties": false, "description": "Results of the `curl` command.", "minProperties": 1, "type": "object", "required": [ "exitCode" ], "properties": { "exitCode": { "description": "Curl command exit code. [List of possible curl exit code.](https://curl.se/libcurl/c/libcurl-errors.html) ", "minimum": 0, "type": "integer" }, "httpStatusCode": { "description": "Returned HTTP response code.", "maximum": 599, "minimum": 100, "type": "integer" }, "httpVersion": { "description": "HTTP version used for `curl`.", "minLength": 1, "type": "string" }, "reasonPhrase": { "description": "Reason phrase for the response.", "minLength": 1, "type": "string" }, "responseBody": { "description": "Entire response body.", "minLength": 1, "type": "string" }, "responseHeaderList": { "description": "Collects the response headers in the format `header: value`.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } }, "timing": { "additionalProperties": false, "description": "Collects the time related data.", "type": "object", "required": [ "dnsLookupTime", "tcpConnectionTime", "sslConnectionTime", "timeToFirstByte", "totalTime" ], "properties": { "dnsLookupTime": { "description": "DNS lookup time, in seconds.", "minimum": 0, "type": "number" }, "sslConnectionTime": { "description": "SSL connection time, in seconds.", "minimum": 0, "type": "number" }, "tcpConnectionTime": { "description": "TCP connection time, in seconds.", "minimum": 0, "type": "number" }, "timeToFirstByte": { "description": "Time to first byte, in seconds.", "minimum": 0, "type": "number" }, "totalTime": { "description": "Total time, in seconds.", "minimum": 0, "type": "number" } } } }, "x-akamai": { "file-path": "schemas/curlResults.yaml" } }, "suggestedActions": { "description": "Suggestions on what to do next with the results.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } } }, "x-akamai": { "file-path": "schemas/contentDetail.yaml" } } }, "createdBy": { "description": "Username who submitted the request.", "minLength": 1, "type": "string" }, "createdTime": { "description": "ISO 8601 timestamp indicating when the request was submitted.", "format": "date-time", "type": "string" }, "errorResponse": { "additionalProperties": false, "description": "Specifies the reason for `FAILURE` status.", "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Details about the error.", "minLength": 1, "type": "string" }, "errors": { "description": "Collects information about problems occurred while fetching the data.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } }, "status": { "description": "Error status code.", "minLength": 1, "type": "string" }, "title": { "description": "Error title.", "minLength": 1, "type": "string" }, "type": { "description": "Error type.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/errorResponse.yaml" } }, "executionStatus": { "description": "Status of the request's execution. Possible values are: `SUCCESS`, `FAILURE`, or `IN_PROGRESS`.", "type": "string", "enum": [ "SUCCESS", "FAILURE", "IN_PROGRESS" ] }, "internalIp": { "description": "Machine IP for the requested location used to forward the request to the origin server.", "minLength": 1, "type": "string" }, "internalIpLocation": { "additionalProperties": false, "description": "Specifies the geolocation of `internalIp`.", "type": "object", "required": [ "city", "regionCode", "countryCode", "asNumber" ], "properties": { "asNumber": { "description": "Autonomous System Number the edge IP maps to.", "minimum": 0, "type": "integer" }, "city": { "description": "Closest city within a 50-mile radius the edge IP maps to.", "minLength": 1, "type": "string" }, "countryCode": { "description": "ISO 3166 country code the edge IP maps to.", "minLength": 1, "type": "string" }, "regionCode": { "description": "ISO 3166 region code the edge IP maps to.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/edgeIpLocation.yaml" } }, "link": { "description": "Link to get the Connectivity problems scenario response after the `retryAfter` interval passes. It occurs only for operations with the `IN_PROGRESS` status.", "minLength": 1, "type": "string" }, "logLines": { "description": "Lists the results of the GREP request.", "minItems": 1, "type": "array", "items": { "additionalProperties": false, "description": "Collects fetched logs.", "type": "object", "required": [ "executionContext", "executionStatus" ], "properties": { "errorResponse": { "additionalProperties": false, "description": "Specifies the reason for `FAILURE` status.", "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Details about the error.", "minLength": 1, "type": "string" }, "errors": { "description": "Collects information about problems occurred while fetching the data.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } }, "status": { "description": "Error status code.", "minLength": 1, "type": "string" }, "title": { "description": "Error title.", "minLength": 1, "type": "string" }, "type": { "description": "Error type.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/errorResponse.yaml" } }, "executionContext": { "description": "Execution context. The only possible value is `DEFAULT`. For now, this member doesn't provide any meaningful data.", "type": "string", "enum": [ "DEFAULT" ] }, "executionStatus": { "description": "Status of the GREP request's execution, either `SUCCESS` or `FAILURE`.", "type": "string", "enum": [ "SUCCESS", "FAILURE" ] }, "result": { "additionalProperties": false, "description": "Provides logs fetched with the GREP command.", "type": "object", "required": [ "logs", "legend" ], "properties": { "legend": { "additionalProperties": false, "description": "Descriptions of returned `logType`, `objectStatus`, `objectStatus2`, `objectStatus3` in `r` and `f` log lines.", "type": "object", "required": [ "logType", "rObjectStatus", "rObjectStatus2", "rObjectStatus3", "fObjectStatus", "fObjectStatus2", "fObjectStatus3" ], "properties": { "fObjectStatus": { "description": "Descriptions of the `objectStatus` data in f-line.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } }, "fObjectStatus2": { "description": "Descriptions of the `objectStatus2` data in f-line.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } }, "fObjectStatus3": { "description": "Descriptions of the `objectStatus3` data in f-line.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } }, "logType": { "description": "Description of the `logType` data.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } }, "rObjectStatus": { "description": "Descriptions of the `objectStatus` data in r-line.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } }, "rObjectStatus2": { "description": "Descriptions of the `objectStatus2` data in r-line.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } }, "rObjectStatus3": { "description": "Descriptions of the `objectStatus3` data in r-line.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } } }, "x-akamai": { "file-path": "schemas/legend.yaml" } }, "logs": { "description": "Filtered log lines.", "minItems": 0, "type": "array", "items": { "description": "Items provided as key/value pairs.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } } } }, "x-akamai": { "file-path": "schemas/logsContainer.yaml" } }, "suggestedActions": { "description": "Suggestions on what to do next with the results.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } } }, "x-akamai": { "file-path": "schemas/logLines.yaml" } } }, "request": { "additionalProperties": false, "description": "Specifies your Connectivity problems scenario request.", "type": "object", "required": [ "url" ], "properties": { "clientIp": { "description": "Client IP for the Connectivity problems scenario to start MTR from. You can use the `ip` value from the `edgeIps` array in the [collected diagnostic data](https://techdocs.akamai.com/edge-diagnostics/reference/get-user-diagnostic-data-group-records).", "minLength": 1, "type": "string" }, "edgeLocationId": { "description": "Unique identifier for an edge server location closest to end users experiencing issues with the URL. Run the [List available edge server locations](https://techdocs.akamai.com/edge-diagnostics/reference/get-edge-locations) operation to get this value.", "minLength": 1, "type": "string" }, "ipVersion": { "description": "IP version for the Connectivity problems scenario to use to run cURL and MTR commands, either `IPV4` or `IPV6`.", "type": "string", "enum": [ "IPV4", "IPV6" ] }, "packetType": { "description": "Packet type for the Connectivity problems scenario to use to run MTR, either `ICMP` or `TCP`.", "type": "string", "enum": [ "ICMP", "TCP" ] }, "port": { "description": "Port number for the Connectivity problems scenario to use to run MTR, either `80` or `443`.", "type": "integer", "enum": [ 80, 443 ] }, "requestHeaders": { "description": "Customized headers for the `curl` request in the format `header: value`. The request includes [Akamai Pragma headers](https://techdocs.akamai.com/edge-diagnostics/docs/pragma-headers) by default.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } }, "runFromSiteShield": { "description": "Runs Connectivity problems from a Site Shield map. To learn more, check [Site Shield requests](https://techdocs.akamai.com/edge-diagnostics/reference/site-shield-requests).", "type": "boolean" }, "sensitiveRequestHeaderKeys": { "description": "Sensitive `requestHeaders` you don't want to store in the database after running the request. Check [Sensitive headers](https://techdocs.akamai.com/edge-diagnostics/reference/sensitive-headers) to see the list of request headers treated as sensitive by default.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } }, "spoofEdgeIp": { "description": "IP of the edge server you want to serve traffic from. You can use the `ip` value from the `edgeIps` array in the [collected diagnostic data](https://techdocs.akamai.com/edge-diagnostics/reference/get-user-diagnostic-data-group-records).", "minLength": 1, "type": "string" }, "url": { "description": "URL you want to run the Connectivity problems scenario for.", "format": "uri", "type": "string" } }, "x-akamai": { "file-path": "schemas/connectivityProblemsRequest.yaml" } }, "requestId": { "description": "Unique identifier for the Connectivity problems scenario request. Store this value to run [Get the Connectivity problems scenario response](https://techdocs.akamai.com/edge-diagnostics/reference/get-connectivity-problems-request) operation.", "minimum": 1, "type": "integer" }, "retryAfter": { "description": "Number of seconds when the request is estimated to have processed. It occurs only for operations with the `IN_PROGRESS` status.", "minimum": 1, "type": "integer" }, "siteShieldIp": { "description": "If your request specifies `runFromSiteShield` as `true`, then this IP was used to run Connectivity problems.", "minLength": 1, "type": "string" }, "siteShieldIpLocation": { "additionalProperties": false, "description": "Specifies the geolocation of the edge server used to run the operation.", "type": "object", "required": [ "city", "regionCode", "countryCode", "asNumber" ], "properties": { "asNumber": { "description": "Autonomous System Number the edge IP maps to.", "minimum": 0, "type": "integer" }, "city": { "description": "Closest city within a 50-mile radius the edge IP maps to.", "minLength": 1, "type": "string" }, "countryCode": { "description": "ISO 3166 country code the edge IP maps to.", "minLength": 1, "type": "string" }, "regionCode": { "description": "ISO 3166 region code the edge IP maps to.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/edgeIpLocation.yaml" } }, "spoofEdgeIpLocation": { "additionalProperties": false, "description": "Specifies the geolocation of the edge server used to serve the request.", "type": "object", "required": [ "city", "regionCode", "countryCode", "asNumber" ], "properties": { "asNumber": { "description": "Autonomous System Number the edge IP maps to.", "minimum": 0, "type": "integer" }, "city": { "description": "Closest city within a 50-mile radius the edge IP maps to.", "minLength": 1, "type": "string" }, "countryCode": { "description": "ISO 3166 country code the edge IP maps to.", "minLength": 1, "type": "string" }, "regionCode": { "description": "ISO 3166 region code the edge IP maps to.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/edgeIpLocation.yaml" } }, "summary": { "additionalProperties": false, "description": "Collects partial results of the Connectivity problems scenario. These results contain fetched data that Edge Diagnostics identified as potential source of issues.", "type": "object", "required": [ "content", "logLines", "connectivity" ], "properties": { "connectivity": { "description": "Lists the results of the MTR request.", "minItems": 0, "type": "array", "items": { "additionalProperties": false, "type": "object", "required": [ "executionStatus", "sourceIpLocation", "destinationIpLocation", "sourceContext", "destinationContext", "executionContext" ], "properties": { "additionalRequestParameters": { "additionalProperties": false, "description": "Specifies the MTR request.", "minProperties": 1, "type": "object", "required": [ "source", "destination" ], "properties": { "destination": { "description": "Destination of the request.", "minLength": 1, "type": "string" }, "ipVersion": { "description": "IP version used by the request, either `IPV4` or `IPV6`.", "type": "string", "enum": [ "IPV4", "IPV6" ] }, "packetType": { "description": "Packet type used by the request, either `ICMP` or `TCP`.", "type": "string", "enum": [ "ICMP", "TCP" ] }, "port": { "description": "Port number used by the request, either `80` or `443`.", "type": "integer", "enum": [ 80, 443 ] }, "source": { "description": "Source of the request.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/additionalMtrRequestParameters.yaml" } }, "destinationContext": { "description": "Whether the destination IP is a `CLIENT_IP` or `ORIGIN_IP`.", "type": "string", "enum": [ "ORIGIN_IP", "CLIENT_IP" ] }, "destinationIpLocation": { "additionalProperties": false, "description": "Specifies the geolocation of the origin server IP.", "type": "object", "required": [ "city", "regionCode", "countryCode", "asNumber" ], "properties": { "asNumber": { "description": "Autonomous System Number the edge IP maps to.", "minimum": 0, "type": "integer" }, "city": { "description": "Closest city within a 50-mile radius the edge IP maps to.", "minLength": 1, "type": "string" }, "countryCode": { "description": "ISO 3166 country code the edge IP maps to.", "minLength": 1, "type": "string" }, "regionCode": { "description": "ISO 3166 region code the edge IP maps to.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/edgeIpLocation.yaml" } }, "errorResponse": { "additionalProperties": false, "description": "Specifies the reason for `FAILURE` status.", "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Details about the error.", "minLength": 1, "type": "string" }, "errors": { "description": "Collects information about problems occurred while fetching the data.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } }, "status": { "description": "Error status code.", "minLength": 1, "type": "string" }, "title": { "description": "Error title.", "minLength": 1, "type": "string" }, "type": { "description": "Error type.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/errorResponse.yaml" } }, "executionContext": { "description": "Execution context for MTR. Edge Diagnostics executes MTR between an edge server and the origin server (`EDGE_IP_TO_ORIGIN_IP`) or, if a client IP is present in the request, between an edge server and the client machine (`EDGE_IP_TO_CLIENT_IP`).", "type": "string", "enum": [ "EDGE_IP_TO_ORIGIN_IP", "EDGE_IP_TO_CLIENT_IP" ] }, "executionStatus": { "description": "Status of the MTR request's execution. Possible values are `SUCCESS`, `FAILURE`, or `NOT_EXECUTED`. The `info` member and `FAILURE` in `errorResponse` provide details for `NOT_EXECUTED`.", "type": "string", "enum": [ "SUCCESS", "FAILURE", "NOT_EXECUTED" ] }, "info": { "additionalProperties": false, "description": "Specifies the reason for `NOT_EXECUTED` status.", "type": "object", "required": [ "key", "message" ], "properties": { "key": { "description": "Error key.", "minLength": 1, "type": "string" }, "message": { "description": "Details about the error.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/info.yaml" } }, "result": { "additionalProperties": false, "description": "Standard MTR results.", "type": "object", "required": [ "startTime", "host", "packetLoss", "averageLatency", "hops", "result" ], "properties": { "averageLatency": { "description": "Average latency for all hops, in seconds.", "minimum": 0, "type": "number" }, "hops": { "description": "Lists network hops with their data.", "minItems": 0, "type": "array", "items": { "additionalProperties": false, "description": "Collects network hops with their data.", "type": "object", "required": [ "number", "host", "ip", "ipLocation", "packetLoss", "sentPackets", "lastPacketLatency", "averageLatency", "bestRtt", "worstRtt", "standardDeviation" ], "properties": { "averageLatency": { "description": "Average hop value, useful to detect ongoing problems.", "minimum": 0, "type": "number" }, "bestRtt": { "description": "Fastest time, in milliseconds.", "minimum": 0, "type": "number" }, "host": { "description": "Host or domain name for the hop.", "minLength": 1, "type": "string" }, "ip": { "description": "IP of the hop's `edgeHost`.", "minLength": 1, "type": "string" }, "ipLocation": { "additionalProperties": false, "description": "Geolocation data for the hop's `edgeHost`.", "type": "object", "required": [ "city", "regionCode", "countryCode", "asNumber" ], "properties": { "asNumber": { "description": "Autonomous System Number the edge IP maps to.", "minimum": 0, "type": "integer" }, "city": { "description": "Closest city within a 50-mile radius the edge IP maps to.", "minLength": 1, "type": "string" }, "countryCode": { "description": "ISO 3166 country code the edge IP maps to.", "minLength": 1, "type": "string" }, "regionCode": { "description": "ISO 3166 region code the edge IP maps to.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/edgeIpLocation.yaml" } }, "lastPacketLatency": { "description": "Last measured hop value, useful to detect ongoing problems.", "minimum": 0, "type": "number" }, "number": { "description": "Index for each hop's count within the full set.", "minimum": 0, "type": "integer" }, "packetLoss": { "description": "Percentage of packets lost for the hop, maximum `100`.", "maximum": 100, "minimum": 0, "type": "number" }, "sentPackets": { "description": "Number of packets sent for the hop.", "minimum": 0, "type": "integer" }, "standardDeviation": { "description": "Standard deviation, in milliseconds.", "minimum": 0, "type": "number" }, "worstRtt": { "description": "Slowest time, in milliseconds.", "minimum": 0, "type": "number" } }, "x-akamai": { "file-path": "schemas/mtrHopInstance.yaml" } } }, "host": { "description": "Hostname within the edge network that corresponds to the `source` IP address.", "format": "hostname", "type": "string" }, "packetLoss": { "description": "Percentage of packets lost, maximum `100`.", "maximum": 100, "minimum": 0, "type": "number" }, "result": { "description": "Raw MTR utility output.", "minLength": 1, "type": "string" }, "startTime": { "description": "Epoch timestamp marking when MTR was run.", "type": "integer" } }, "x-akamai": { "file-path": "schemas/mtrData.yaml" } }, "sourceContext": { "description": "Context for MTR source. The source can be either an edge server forwarding the request to the origin server (`EDGE_IP_CONNECTED_TO_ORIGIN`) or an edge server in the location (`EDGE_IP_BASED_ON_LOCATION`), either selected randomly or provided in the request.", "type": "string", "enum": [ "EDGE_IP_CONNECTED_TO_ORIGIN", "EDGE_IP_BASED_ON_LOCATION" ] }, "sourceIpLocation": { "additionalProperties": false, "description": "Specifies the geolocation of the source IP.", "type": "object", "required": [ "city", "regionCode", "countryCode", "asNumber" ], "properties": { "asNumber": { "description": "Autonomous System Number the edge IP maps to.", "minimum": 0, "type": "integer" }, "city": { "description": "Closest city within a 50-mile radius the edge IP maps to.", "minLength": 1, "type": "string" }, "countryCode": { "description": "ISO 3166 country code the edge IP maps to.", "minLength": 1, "type": "string" }, "regionCode": { "description": "ISO 3166 region code the edge IP maps to.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/edgeIpLocation.yaml" } }, "suggestedActions": { "description": "Suggestions on what to do next with the results.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } } }, "x-akamai": { "file-path": "schemas/connectivity.yaml" } } }, "content": { "description": "Lists the results of the cURL request.", "minItems": 0, "type": "array", "items": { "additionalProperties": false, "type": "object", "required": [ "executionContext", "executionStatus" ], "properties": { "additionalRequestParameters": { "additionalProperties": false, "description": "Specifies the cURL request.", "minProperties": 1, "type": "object", "properties": { "includeDefaultPragmaHeaders": { "description": "Indicates whether the request included the default list of `Pragma` headers. Check [Pragma headers](https://techdocs.akamai.com/edge-diagnostics/docs/pragma-headers) to learn about default Akamai Pragma headers.", "type": "boolean" }, "ipVersion": { "description": "IP version used by the request, either `IPV4` or `IPV6`.", "type": "string", "enum": [ "IPV4", "IPV6" ] }, "requestHeaders": { "description": "Customized headers for `curl` request in the format `header: value`.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } } }, "x-akamai": { "file-path": "schemas/additionalCurlRequestParameters.yaml" } }, "errorResponse": { "additionalProperties": false, "description": "Specifies the reason for `FAILURE` status.", "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Details about the error.", "minLength": 1, "type": "string" }, "errors": { "description": "Collects information about problems occurred while fetching the data.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } }, "status": { "description": "Error status code.", "minLength": 1, "type": "string" }, "title": { "description": "Error title.", "minLength": 1, "type": "string" }, "type": { "description": "Error type.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/errorResponse.yaml" } }, "executionContext": { "description": "Execution context. The only possible value is `DEFAULT`. For now, this member doesn't provide any meaningful data.", "type": "string", "enum": [ "DEFAULT" ] }, "executionStatus": { "description": "Status of the cURL request's execution, either `SUCCESS` or `FAILURE`.", "type": "string", "enum": [ "SUCCESS", "FAILURE" ] }, "result": { "additionalProperties": false, "description": "Results of the `curl` command.", "minProperties": 1, "type": "object", "required": [ "exitCode" ], "properties": { "exitCode": { "description": "Curl command exit code. [List of possible curl exit code.](https://curl.se/libcurl/c/libcurl-errors.html) ", "minimum": 0, "type": "integer" }, "httpStatusCode": { "description": "Returned HTTP response code.", "maximum": 599, "minimum": 100, "type": "integer" }, "httpVersion": { "description": "HTTP version used for `curl`.", "minLength": 1, "type": "string" }, "reasonPhrase": { "description": "Reason phrase for the response.", "minLength": 1, "type": "string" }, "responseBody": { "description": "Entire response body.", "minLength": 1, "type": "string" }, "responseHeaderList": { "description": "Collects the response headers in the format `header: value`.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } }, "timing": { "additionalProperties": false, "description": "Collects the time related data.", "type": "object", "required": [ "dnsLookupTime", "tcpConnectionTime", "sslConnectionTime", "timeToFirstByte", "totalTime" ], "properties": { "dnsLookupTime": { "description": "DNS lookup time, in seconds.", "minimum": 0, "type": "number" }, "sslConnectionTime": { "description": "SSL connection time, in seconds.", "minimum": 0, "type": "number" }, "tcpConnectionTime": { "description": "TCP connection time, in seconds.", "minimum": 0, "type": "number" }, "timeToFirstByte": { "description": "Time to first byte, in seconds.", "minimum": 0, "type": "number" }, "totalTime": { "description": "Total time, in seconds.", "minimum": 0, "type": "number" } } } }, "x-akamai": { "file-path": "schemas/curlResults.yaml" } }, "suggestedActions": { "description": "Suggestions on what to do next with the results.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } } }, "x-akamai": { "file-path": "schemas/contentDetail.yaml" } } }, "logLines": { "description": "Lists the results of the GREP request.", "minItems": 0, "type": "array", "items": { "additionalProperties": false, "description": "Collects fetched logs.", "type": "object", "required": [ "executionContext", "executionStatus" ], "properties": { "errorResponse": { "additionalProperties": false, "description": "Specifies the reason for `FAILURE` status.", "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Details about the error.", "minLength": 1, "type": "string" }, "errors": { "description": "Collects information about problems occurred while fetching the data.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } }, "status": { "description": "Error status code.", "minLength": 1, "type": "string" }, "title": { "description": "Error title.", "minLength": 1, "type": "string" }, "type": { "description": "Error type.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/errorResponse.yaml" } }, "executionContext": { "description": "Execution context. The only possible value is `DEFAULT`. For now, this member doesn't provide any meaningful data.", "type": "string", "enum": [ "DEFAULT" ] }, "executionStatus": { "description": "Status of the GREP request's execution, either `SUCCESS` or `FAILURE`.", "type": "string", "enum": [ "SUCCESS", "FAILURE" ] }, "result": { "additionalProperties": false, "description": "Provides logs fetched with the GREP command.", "type": "object", "required": [ "logs", "legend" ], "properties": { "legend": { "additionalProperties": false, "description": "Descriptions of returned `logType`, `objectStatus`, `objectStatus2`, `objectStatus3` in `r` and `f` log lines.", "type": "object", "required": [ "logType", "rObjectStatus", "rObjectStatus2", "rObjectStatus3", "fObjectStatus", "fObjectStatus2", "fObjectStatus3" ], "properties": { "fObjectStatus": { "description": "Descriptions of the `objectStatus` data in f-line.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } }, "fObjectStatus2": { "description": "Descriptions of the `objectStatus2` data in f-line.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } }, "fObjectStatus3": { "description": "Descriptions of the `objectStatus3` data in f-line.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } }, "logType": { "description": "Description of the `logType` data.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } }, "rObjectStatus": { "description": "Descriptions of the `objectStatus` data in r-line.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } }, "rObjectStatus2": { "description": "Descriptions of the `objectStatus2` data in r-line.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } }, "rObjectStatus3": { "description": "Descriptions of the `objectStatus3` data in r-line.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } } }, "x-akamai": { "file-path": "schemas/legend.yaml" } }, "logs": { "description": "Filtered log lines.", "minItems": 0, "type": "array", "items": { "description": "Items provided as key/value pairs.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } } } }, "x-akamai": { "file-path": "schemas/logsContainer.yaml" } }, "suggestedActions": { "description": "Suggestions on what to do next with the results.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } } }, "x-akamai": { "file-path": "schemas/logLines.yaml" } } } }, "x-akamai": { "file-path": "schemas/connectivityProblemsSummary.yaml" } } }, "x-akamai": { "file-path": "schemas/connectivityProblemsResponse.yaml" } } } }, "headers": { "X-RateLimit-Limit": { "description": "The rate limit ceiling for this endpoint.", "example": 10, "schema": { "type": "integer" }, "x-akamai": { "file-path": "headers/X-RateLimit-Limit.yaml" } }, "X-RateLimit-Remaining": { "description": "The number of requests left for the time window.", "example": 5, "schema": { "type": "integer" }, "x-akamai": { "file-path": "headers/X-RateLimit-Remaining.yaml" } } } }, "400": { "description": "[Validation error](https://techdocs.akamai.com/edge-diagnostics/reference/400).", "content": { "application/problem+json": { "example": { "detail": "Provide only one of these members, either `edgeLocationId` or `edgeIp`.", "status": 400, "title": "Incorrect request.", "type": "bad.request.error", "errors": [ { "requestField": "edgeLocationId", "title": "Conflicting values.", "type": "field.conflict" }, { "requestField": "edgeIp", "title": "Conflicting values.", "type": "field.conflict" } ] }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/400.yaml" } }, "401": { "description": "[Authorization error](https://techdocs.akamai.com/edge-diagnostics/reference/401).", "content": { "application/problem+json": { "example": { "detail": "Inactive client token", "instance": "https://akab-nedrvuylepskzabx-lv3dgceqqktx3i5b.luna.akamaiapis.net/edge-diagnostics/v1/grep/requests", "status": 401, "title": "Not authorized", "type": "https://problems.luna.akamaiapis.net/-/pep-authn/deny" }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/401.yaml" } }, "403": { "description": "[Permission error](https://techdocs.akamai.com/edge-diagnostics/reference/403).", "content": { "application/problem+json": { "example": { "status": 403, "title": "Forbidden request.", "type": "forbidden.request.error", "errors": [ { "detail": "You don't have access to the requested URL. Contact your Admin to request access.", "requestField": "url", "title": "Field access denied.", "type": "field.access.denied" } ] }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/403.yaml" } }, "405": { "description": "[Method not allowed](https://techdocs.akamai.com/edge-diagnostics/reference/405).", "content": { "application/problem+json": { "example": { "title": "Method not allowed", "type": "method.not.allowed" }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/405.yaml" } }, "429": { "description": "[Too many requests](https://techdocs.akamai.com/edge-diagnostics/reference/429).", "content": { "application/problem+json": { "example": { "detail": "You have exceeded total number of requests configured for this API.", "status": 429, "title": "Too Many Requests", "type": "requests.exceeded.error" }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/429.yaml" } } }, "parameters": [ { "description": "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ] } }, "/connectivity-problems/requests/{requestId}": { "get": { "description": "Returns the status of the [asynchronous](https://techdocs.akamai.com/edge-diagnostics/reference/asynchronous-processes) [Run the connectivity problems scenario](https://techdocs.akamai.com/edge-diagnostics/reference/post-connectivity-problems) request. Operations with the `SUCCESS` status include also fetched GREP, cURL, and MTR data.", "operationId": "get-connectivity-problems-request", "summary": "Get the Connectivity problems scenario response", "tags": [ "Connectivity problems" ], "externalDocs": { "description": "See documentation for this operation in Akamai's Edge Diagnostics API", "url": "https://techdocs.akamai.com/edge-diagnostics/reference/get-connectivity-problems-request" }, "responses": { "200": { "description": "The response provides the status of the request and its details.", "content": { "application/json": { "example": { "createdBy": "jperez", "createdTime": "2021-09-29T03:56:01Z", "executionStatus": "SUCCESS", "internalIp": "192.0.2.5", "requestId": 181, "clientIpLocation": { "asNumber": 9583, "city": "BANGALORE", "countryCode": "IN", "regionCode": "KA" }, "internalIpLocation": { "asNumber": 20940, "city": "ASHBURN", "countryCode": "US", "regionCode": "VA" }, "request": { "clientIp": "2001:db8::4", "edgeLocationId": "allen-tx-unitedregionCodes", "ipVersion": "IPV6", "packetType": "ICMP", "port": 443, "spoofEdgeIp": "192.0.2.9", "url": "http://www.atcuser15.akamaiu.com", "requestHeaders": [ "X-Location: NGDT" ] }, "spoofEdgeIpLocation": { "asNumber": 20940, "city": "MUMBAI", "countryCode": "IN", "regionCode": "MH" }, "summary": { "connectivity": [ { "destinationContext": "CLIENT_IP", "executionContext": "EDGE_IP_TO_CLIENT_IP", "executionStatus": "SUCCESS", "sourceContext": "EDGE_IP_BASED_ON_LOCATION", "suggestedActions": [ "Look for a packet loss or sudden jumps in the hop time.", "For a loss or latency within the end user ISP network, ask the end user to contact thier ISP.", "For a loss or latency within Akamai network, contact Akamai Technical Support.", "If a packet loss occurs at one hop but does not propogate to the end of the trace, it is irrelevant." ], "additionalRequestParameters": { "destination": "2001:db8::4", "source": "192.0.2.219" }, "destinationIpLocation": { "asNumber": 9583, "city": "BANGALORE", "countryCode": "IN", "regionCode": "KA" }, "result": { "host": "a23-50-51-236.deploy.akamaitechnologies.com", "hops": [ { "averageLatency": 0, "bestRtt": 0, "host": "???", "lastPacketLatency": 0, "number": 7, "packetLoss": 100, "sentPackets": 10, "standardDeviation": 0, "worstRtt": 0 }, { "averageLatency": 323.7, "bestRtt": 226.9, "ip": "2001:db8:fd8b:5d04:82a1:c752:65fa:94b3", "lastPacketLatency": 408.5, "number": 5, "packetLoss": 20, "sentPackets": 10, "standardDeviation": 103.5, "worstRtt": 426.2, "ipLocation": { "asNumber": 9498, "city": "BANGALORE", "countryCode": "IN", "regionCode": "KA" } } ] }, "sourceIpLocation": { "asNumber": 20940, "city": "ASHBURN", "countryCode": "US", "regionCode": "VA" } }, { "destinationContext": "ORIGIN_IP", "executionContext": "EDGE_IP_TO_ORIGIN_IP", "executionStatus": "SUCCESS", "sourceContext": "EDGE_IP_CONNECTED_TO_ORIGIN", "suggestedActions": [ "Look for a packet loss or sudden jumps in the hop time.", "For a loss or latency within the end user ISP network, ask the end user to contact thier ISP.", "For a loss or latency within Akamai network, contact Akamai Technical Support.", "If a packet loss occurs at one hop but does not propogate to the end of the trace, it is irrelevant." ], "additionalRequestParameters": { "destination": "2001:db8:70dd:6d98:f9ae:5876:c2b8:34fd", "source": "192.0.2.14" }, "destinationIpLocation": { "asNumber": 20940, "city": "ASHBURN", "countryCode": "US", "regionCode": "VA" }, "result": { "host": "a23-212-50-38.deploy.akamaitechnologies.com", "hops": [ { "averageLatency": 8577, "bestRtt": 7550, "host": "ae0.tata-bom3.netarch.akamai.com", "ip": "2001:db8:c72a:c70d:f18a:273d:28d7:ae4c", "lastPacketLatency": 7550, "number": 1, "packetLoss": 60, "sentPackets": 10, "standardDeviation": 956.9, "worstRtt": 9749, "ipLocation": { "asNumber": 20940, "city": "MUMBAI", "countryCode": "IN", "regionCode": "MH" } } ] }, "sourceIpLocation": { "asNumber": 20940, "city": "MUMBAI", "countryCode": "IN", "regionCode": "MH" } } ], "content": [ { "executionContext": "DEFAULT", "executionStatus": "SUCCESS", "suggestedActions": [ "Compare the response headers served from edge and origin.", "Check for content correctness.", "Check content length/bytes served." ], "additionalRequestParameters": { "requestHeaders": [ "Pragma: akamai-x-cache-on, akamai-x-cache-remote-on, akamai-x-check-cacheable, akamai-x-get-true-cache-key, akamai-x-get-cache-key, akamai-x-serial-no, akamai-x-get-request-id" ] }, "result": { "responseHeaderList": [ "Last-Modified: Thu, 12 Feb 2015 15:44:28 GMT", "Content-Length: 15051" ] } } ], "logLines": [ { "executionContext": "DEFAULT", "executionStatus": "SUCCESS", "suggestedActions": [ "Check for long times.", "Check content length/bytes served." ], "result": { "legend": { "fObjectStatus": { "D": "A default object was served.", "a": "This response was sent through the ESI processor.", "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." }, "fObjectStatus2": {}, "fObjectStatus3": {}, "logType": { "f": "(f) going forward to forward hostname" }, "rObjectStatus": {}, "rObjectStatus2": {}, "rObjectStatus3": {} }, "logs": [ { "clientIp": "192.0.2.5", "contentBytesServed": "-", "edgeIp": "192.0.2.14", "forwardIp": "192.0.2.15", "logType": "f", "objectStatus": "oaDx", "timeTaken": "0", "turnaroundTime": "268" } ] } } ] }, "connectivity": [ { "destinationContext": "ORIGIN_IP", "executionContext": "EDGE_IP_TO_ORIGIN_IP", "executionStatus": "SUCCESS", "sourceContext": "EDGE_IP_CONNECTED_TO_ORIGIN", "suggestedActions": [ "Look for a packet loss or sudden jumps in the hop time.", "For a loss or latency within the end user ISP network, ask the end user to contact thier ISP.", "For a loss or latency within Akamai network, contact Akamai Technical Support.", "If a packet loss occurs at one hop but does not propogate to the end of the trace, it is irrelevant.", "If source Ip country and destination IP country is same then there should not be any hops outside the country." ], "additionalRequestParameters": { "destination": "2001:db8:d1cd:c365:4391:908f:9129:dd2b", "source": "192.0.2.14" }, "destinationIpLocation": { "asNumber": 20940, "city": "ASHBURN", "countryCode": "US", "regionCode": "VA" }, "result": { "averageLatency": 200.3, "host": "a23-212-50-38.deploy.akamaitechnologies.com", "packetLoss": 0, "result": "Start: 2021-09-29T03:56:40+0000\nHOST: a23-212-50-38.deploy.akamaitechnologies.com Loss% Snt Last Avg Best Wrst StDev\n 1.|-- ae0.tata-bom3.netarch.akamai.com (2600:140f:4::1) 60.0% 10 7550. 8577. 7550. 9749. 956.9\n 2.|-- 2403:0:100::911 0.0% 10 0.5 0.6 0.3 2.8 0.8\n 3.|-- if-ae-1-101.tcore2.mlv-mumbai.ipv6.as6453.net (2001:db8::c) 0.0% 10 0.4 4.4 0.3 37.5 11.6\n 4.|-- if-ae-12-2.tcore1.l78-london.ipv6.as6453.net (2001:db8::d) 0.0% 10 128.4 128.4 128.2 129.0 0.2\n 5.|-- if-ae-15-2.tcore3.njy-newark.ipv6.as6453.net (2001:db8::e) 0.0% 10 199.5 199.5 199.4 199.7 0.1\n 6.|-- if-ae-1-3.tcore4.njy-newark.ipv6.as6453.net (2001:db8::b) 0.0% 10 199.3 205.2 199.2 227.7 10.0\n 7.|-- if-ae-12-2.tcore3.aeq-ashburn.ipv6.as6453.net (2001:db8::b) 0.0% 10 204.3 204.4 204.2 204.6 0.1\n 8.|-- 2001:5a0:600:502::2 0.0% 10 204.3 204.3 204.2 204.4 0.0\n 9.|-- ae1.r01.iad01.icn.netarch.akamai.com (2600:1488:a180:125::a) 0.0% 10 215.6 214.2 204.5 262.8 17.6\n 10.|-- ae3.r01.iad03.icn.netarch.akamai.com (2600:1488:5fc3:4d::b) 0.0% 10 213.3 206.9 204.4 213.3 3.3\n 11.|-- ae21.r02.iad03.ien.netarch.akamai.com (2600:1488:a181:211::b) 0.0% 10 218.4 206.3 200.1 227.5 9.8\n 12.|-- ae3.ctl-iad4.netarch.akamai.com (2600:1488:a181:205::b) 0.0% 10 205.0 240.7 204.8 382.7 68.8\n 13.|-- g2600-1408-7400-0000-0000-0000-17c7-3f1b.deploy.static.akamaitechnologies.com (2 0.0% 10 200.3 200.3 200.3 200.6 0.1", "startTime": 1632887800, "hops": [ { "averageLatency": 8577, "bestRtt": 7550, "host": "ae0.tata-bom3.netarch.akamai.com", "ip": "2001:db8:5480:5df6:c4ea:1f7c:3ae:d764", "lastPacketLatency": 7550, "number": 1, "packetLoss": 60, "sentPackets": 10, "standardDeviation": 956.9, "worstRtt": 9749, "ipLocation": { "asNumber": 20940, "city": "MUMBAI", "countryCode": "IN", "regionCode": "MH" } }, { "averageLatency": 200.3, "bestRtt": 200.3, "host": "g2600-1408-7400-0000-0000-0000-17c7-3f1b.deploy.static.akamaitechnologies.com", "lastPacketLatency": 200.3, "number": 2, "packetLoss": 0, "sentPackets": 10, "standardDeviation": 0.1, "worstRtt": 200.6 } ] }, "sourceIpLocation": { "asNumber": 20940, "city": "MUMBAI", "countryCode": "IN", "regionCode": "MH" } }, { "destinationContext": "CLIENT_IP", "executionContext": "EDGE_IP_TO_CLIENT_IP", "executionStatus": "SUCCESS", "sourceContext": "EDGE_IP_BASED_ON_LOCATION", "suggestedActions": [ "Look for a packet loss or sudden jumps in the hop time.", "For a loss or latency within the end user ISP network, ask the end user to contact thier ISP.", "For a loss or latency within Akamai network, contact Akamai Technical Support.", "If a packet loss occurs at one hop but does not propogate to the end of the trace, it is irrelevant.", "If source Ip country and destination IP country is same then there should not be any hops outside the country." ], "additionalRequestParameters": { "destination": "2001:db8::4", "source": "192.0.2.45" }, "destinationIpLocation": { "asNumber": 9583, "city": "BANGALORE", "countryCode": "IN", "regionCode": "KA" }, "result": { "averageLatency": 0, "host": "a23-50-51-236.deploy.akamaitechnologies.com", "packetLoss": 100, "result": "Start: 2021-09-29T03:56:18+0000\nHOST: a23-50-51-236.deploy.akamaitechnologies.com Loss% Snt Last Avg Best Wrst StDev\n 1.|-- ae0.cyrusone-iad2.netarch.akamai.com (2600:1408:24::1) 0.0% 10 22.6 29.4 7.2 96.5 26.3\n 2.|-- ae0-86.cr2-was1.ip6.gtt.net (2001:668:0:3:ffff:0:45ae:1189) 0.0% 10 0.5 4.7 0.3 36.6 11.4\n 3.|-- 2001:668:0:2:ffff:0:5995:8dd5 0.0% 10 74.4 79.2 73.5 96.1 8.9\n 4.|-- 2001:668:0:3:ffff:0:4d43:50be 0.0% 10 71.4 73.1 70.9 89.6 5.8\n 5.|-- 2404:a800::60 20.0% 10 408.5 323.7 226.9 426.2 103.5\n 6.|-- 2404:a800:3a00::1ba 0.0% 10 227.5 227.6 227.5 227.8 0.1\n 7.|-- ??? 100.0 10 0.0 0.0 0.0 0.0 0.0", "startTime": 1632887778, "hops": [ { "averageLatency": 29.4, "bestRtt": 7.2, "host": "ae0.cyrusone-iad2.netarch.akamai.com", "ip": "2001:db8:20ac:e9d4:eaa3:aaf5:45e8:30af", "lastPacketLatency": 22.6, "number": 1, "packetLoss": 0, "sentPackets": 10, "standardDeviation": 26.3, "worstRtt": 96.5, "ipLocation": { "asNumber": 20940, "city": "ASHBURN", "countryCode": "US", "regionCode": "VA" } }, { "averageLatency": 0, "bestRtt": 0, "host": "???", "lastPacketLatency": 0, "number": 2, "packetLoss": 100, "sentPackets": 10, "standardDeviation": 0, "worstRtt": 0 } ] }, "sourceIpLocation": { "asNumber": 20940, "city": "ASHBURN", "countryCode": "US", "regionCode": "VA" } } ], "content": [ { "executionContext": "DEFAULT", "executionStatus": "SUCCESS", "suggestedActions": [ "Compare the response headers served from edge and origin.", "Check for content correctness.", "Check content length/bytes served." ], "additionalRequestParameters": { "requestHeaders": [ "Pragma: akamai-x-cache-on, akamai-x-cache-remote-on, akamai-x-check-cacheable, akamai-x-get-true-cache-key, akamai-x-get-cache-key, akamai-x-serial-no, akamai-x-get-request-id" ] }, "result": { "httpStatusCode": 200, "httpVersion": "HTTP/1.1", "reasonPhrase": "OK", "responseHeaderList": [ "X-Cache: TCP_MISS from a23-212-50-38.deploy.akamaitechnologies.com (AkamaiGHost/10.4.4-34537092) (-)", "X-True-Cache-Key: /D/000/akamaiflowershop.com/ vcd=1456", "Content-Length: 15051", "Content-Type: text/html" ], "timing": { "dnsLookupTime": 1.509502, "sslConnectionTime": 0, "tcpConnectionTime": 1.524193, "timeToFirstByte": 1.555875, "totalTime": 2.091051 } } } ], "logLines": [ { "executionContext": "DEFAULT", "executionStatus": "SUCCESS", "suggestedActions": [ "Check for long times.", "Check content length/bytes served." ], "result": { "legend": { "fObjectStatus": { "D": "A default object was served.", "a": "This response was sent through the ESI processor.", "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." }, "fObjectStatus2": {}, "fObjectStatus3": {}, "logType": { "f": "(f) going forward to forward hostname" }, "rObjectStatus": {}, "rObjectStatus2": {}, "rObjectStatus3": {} }, "logs": [ { "arl": "/D/16382/1234567/000/akamaiflowershop.com/", "bytesReceived": "3980", "bytesServed": "-", "clientIp": "192.0.2.5", "contentBytesServed": "-", "contentType": "text/html", "cookie": "-", "cpCode": "1234567", "dateTime": "2021-09-29T03:56:05.609Z", "edgeIp": "192.0.2.14", "error": "-", "forwardIp": "192.0.2.15", "hostHeader": "-", "httpMethod": "GET", "httpStatus": "200", "logType": "f", "objectSize": "-", "objectStatus": "oaDx", "objectStatus2": "-", "objectStatus3": "-", "referer": "-", "sslVersion": "-", "timeTaken": "0", "turnaroundTime": "268", "userAgent": "-" } ] } } ] }, "schema": { "additionalProperties": false, "description": "Collects the Connectivity problems scenario results and details about the request.", "type": "object", "required": [ "createdBy", "createdTime", "executionStatus", "internalIp", "internalIpLocation", "request", "requestId", "summary", "content", "connectivity", "logLines" ], "properties": { "clientIpLocation": { "additionalProperties": false, "description": "Specifies the geolocation of the Client IP.", "type": "object", "required": [ "city", "regionCode", "countryCode", "asNumber" ], "properties": { "asNumber": { "description": "Autonomous System Number the edge IP maps to.", "minimum": 0, "type": "integer" }, "city": { "description": "Closest city within a 50-mile radius the edge IP maps to.", "minLength": 1, "type": "string" }, "countryCode": { "description": "ISO 3166 country code the edge IP maps to.", "minLength": 1, "type": "string" }, "regionCode": { "description": "ISO 3166 region code the edge IP maps to.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/edgeIpLocation.yaml" } }, "connectivity": { "description": "Lists the results of the MTR request.", "minItems": 1, "type": "array", "items": { "additionalProperties": false, "type": "object", "required": [ "executionStatus", "sourceIpLocation", "destinationIpLocation", "sourceContext", "destinationContext", "executionContext" ], "properties": { "additionalRequestParameters": { "additionalProperties": false, "description": "Specifies the MTR request.", "minProperties": 1, "type": "object", "required": [ "source", "destination" ], "properties": { "destination": { "description": "Destination of the request.", "minLength": 1, "type": "string" }, "ipVersion": { "description": "IP version used by the request, either `IPV4` or `IPV6`.", "type": "string", "enum": [ "IPV4", "IPV6" ] }, "packetType": { "description": "Packet type used by the request, either `ICMP` or `TCP`.", "type": "string", "enum": [ "ICMP", "TCP" ] }, "port": { "description": "Port number used by the request, either `80` or `443`.", "type": "integer", "enum": [ 80, 443 ] }, "source": { "description": "Source of the request.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/additionalMtrRequestParameters.yaml" } }, "destinationContext": { "description": "Whether the destination IP is a `CLIENT_IP` or `ORIGIN_IP`.", "type": "string", "enum": [ "ORIGIN_IP", "CLIENT_IP" ] }, "destinationIpLocation": { "additionalProperties": false, "description": "Specifies the geolocation of the origin server IP.", "type": "object", "required": [ "city", "regionCode", "countryCode", "asNumber" ], "properties": { "asNumber": { "description": "Autonomous System Number the edge IP maps to.", "minimum": 0, "type": "integer" }, "city": { "description": "Closest city within a 50-mile radius the edge IP maps to.", "minLength": 1, "type": "string" }, "countryCode": { "description": "ISO 3166 country code the edge IP maps to.", "minLength": 1, "type": "string" }, "regionCode": { "description": "ISO 3166 region code the edge IP maps to.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/edgeIpLocation.yaml" } }, "errorResponse": { "additionalProperties": false, "description": "Specifies the reason for `FAILURE` status.", "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Details about the error.", "minLength": 1, "type": "string" }, "errors": { "description": "Collects information about problems occurred while fetching the data.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } }, "status": { "description": "Error status code.", "minLength": 1, "type": "string" }, "title": { "description": "Error title.", "minLength": 1, "type": "string" }, "type": { "description": "Error type.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/errorResponse.yaml" } }, "executionContext": { "description": "Execution context for MTR. Edge Diagnostics executes MTR between an edge server and the origin server (`EDGE_IP_TO_ORIGIN_IP`) or, if a client IP is present in the request, between an edge server and the client machine (`EDGE_IP_TO_CLIENT_IP`).", "type": "string", "enum": [ "EDGE_IP_TO_ORIGIN_IP", "EDGE_IP_TO_CLIENT_IP" ] }, "executionStatus": { "description": "Status of the MTR request's execution. Possible values are `SUCCESS`, `FAILURE`, or `NOT_EXECUTED`. The `info` member and `FAILURE` in `errorResponse` provide details for `NOT_EXECUTED`.", "type": "string", "enum": [ "SUCCESS", "FAILURE", "NOT_EXECUTED" ] }, "info": { "additionalProperties": false, "description": "Specifies the reason for `NOT_EXECUTED` status.", "type": "object", "required": [ "key", "message" ], "properties": { "key": { "description": "Error key.", "minLength": 1, "type": "string" }, "message": { "description": "Details about the error.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/info.yaml" } }, "result": { "additionalProperties": false, "description": "Standard MTR results.", "type": "object", "required": [ "startTime", "host", "packetLoss", "averageLatency", "hops", "result" ], "properties": { "averageLatency": { "description": "Average latency for all hops, in seconds.", "minimum": 0, "type": "number" }, "hops": { "description": "Lists network hops with their data.", "minItems": 0, "type": "array", "items": { "additionalProperties": false, "description": "Collects network hops with their data.", "type": "object", "required": [ "number", "host", "ip", "ipLocation", "packetLoss", "sentPackets", "lastPacketLatency", "averageLatency", "bestRtt", "worstRtt", "standardDeviation" ], "properties": { "averageLatency": { "description": "Average hop value, useful to detect ongoing problems.", "minimum": 0, "type": "number" }, "bestRtt": { "description": "Fastest time, in milliseconds.", "minimum": 0, "type": "number" }, "host": { "description": "Host or domain name for the hop.", "minLength": 1, "type": "string" }, "ip": { "description": "IP of the hop's `edgeHost`.", "minLength": 1, "type": "string" }, "ipLocation": { "additionalProperties": false, "description": "Geolocation data for the hop's `edgeHost`.", "type": "object", "required": [ "city", "regionCode", "countryCode", "asNumber" ], "properties": { "asNumber": { "description": "Autonomous System Number the edge IP maps to.", "minimum": 0, "type": "integer" }, "city": { "description": "Closest city within a 50-mile radius the edge IP maps to.", "minLength": 1, "type": "string" }, "countryCode": { "description": "ISO 3166 country code the edge IP maps to.", "minLength": 1, "type": "string" }, "regionCode": { "description": "ISO 3166 region code the edge IP maps to.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/edgeIpLocation.yaml" } }, "lastPacketLatency": { "description": "Last measured hop value, useful to detect ongoing problems.", "minimum": 0, "type": "number" }, "number": { "description": "Index for each hop's count within the full set.", "minimum": 0, "type": "integer" }, "packetLoss": { "description": "Percentage of packets lost for the hop, maximum `100`.", "maximum": 100, "minimum": 0, "type": "number" }, "sentPackets": { "description": "Number of packets sent for the hop.", "minimum": 0, "type": "integer" }, "standardDeviation": { "description": "Standard deviation, in milliseconds.", "minimum": 0, "type": "number" }, "worstRtt": { "description": "Slowest time, in milliseconds.", "minimum": 0, "type": "number" } }, "x-akamai": { "file-path": "schemas/mtrHopInstance.yaml" } } }, "host": { "description": "Hostname within the edge network that corresponds to the `source` IP address.", "format": "hostname", "type": "string" }, "packetLoss": { "description": "Percentage of packets lost, maximum `100`.", "maximum": 100, "minimum": 0, "type": "number" }, "result": { "description": "Raw MTR utility output.", "minLength": 1, "type": "string" }, "startTime": { "description": "Epoch timestamp marking when MTR was run.", "type": "integer" } }, "x-akamai": { "file-path": "schemas/mtrData.yaml" } }, "sourceContext": { "description": "Context for MTR source. The source can be either an edge server forwarding the request to the origin server (`EDGE_IP_CONNECTED_TO_ORIGIN`) or an edge server in the location (`EDGE_IP_BASED_ON_LOCATION`), either selected randomly or provided in the request.", "type": "string", "enum": [ "EDGE_IP_CONNECTED_TO_ORIGIN", "EDGE_IP_BASED_ON_LOCATION" ] }, "sourceIpLocation": { "additionalProperties": false, "description": "Specifies the geolocation of the source IP.", "type": "object", "required": [ "city", "regionCode", "countryCode", "asNumber" ], "properties": { "asNumber": { "description": "Autonomous System Number the edge IP maps to.", "minimum": 0, "type": "integer" }, "city": { "description": "Closest city within a 50-mile radius the edge IP maps to.", "minLength": 1, "type": "string" }, "countryCode": { "description": "ISO 3166 country code the edge IP maps to.", "minLength": 1, "type": "string" }, "regionCode": { "description": "ISO 3166 region code the edge IP maps to.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/edgeIpLocation.yaml" } }, "suggestedActions": { "description": "Suggestions on what to do next with the results.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } } }, "x-akamai": { "file-path": "schemas/connectivity.yaml" } } }, "content": { "description": "Lists the results of the cURL request.", "minItems": 1, "type": "array", "items": { "additionalProperties": false, "type": "object", "required": [ "executionContext", "executionStatus" ], "properties": { "additionalRequestParameters": { "additionalProperties": false, "description": "Specifies the cURL request.", "minProperties": 1, "type": "object", "properties": { "includeDefaultPragmaHeaders": { "description": "Indicates whether the request included the default list of `Pragma` headers. Check [Pragma headers](https://techdocs.akamai.com/edge-diagnostics/docs/pragma-headers) to learn about default Akamai Pragma headers.", "type": "boolean" }, "ipVersion": { "description": "IP version used by the request, either `IPV4` or `IPV6`.", "type": "string", "enum": [ "IPV4", "IPV6" ] }, "requestHeaders": { "description": "Customized headers for `curl` request in the format `header: value`.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } } }, "x-akamai": { "file-path": "schemas/additionalCurlRequestParameters.yaml" } }, "errorResponse": { "additionalProperties": false, "description": "Specifies the reason for `FAILURE` status.", "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Details about the error.", "minLength": 1, "type": "string" }, "errors": { "description": "Collects information about problems occurred while fetching the data.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } }, "status": { "description": "Error status code.", "minLength": 1, "type": "string" }, "title": { "description": "Error title.", "minLength": 1, "type": "string" }, "type": { "description": "Error type.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/errorResponse.yaml" } }, "executionContext": { "description": "Execution context. The only possible value is `DEFAULT`. For now, this member doesn't provide any meaningful data.", "type": "string", "enum": [ "DEFAULT" ] }, "executionStatus": { "description": "Status of the cURL request's execution, either `SUCCESS` or `FAILURE`.", "type": "string", "enum": [ "SUCCESS", "FAILURE" ] }, "result": { "additionalProperties": false, "description": "Results of the `curl` command.", "minProperties": 1, "type": "object", "required": [ "exitCode" ], "properties": { "exitCode": { "description": "Curl command exit code. [List of possible curl exit code.](https://curl.se/libcurl/c/libcurl-errors.html) ", "minimum": 0, "type": "integer" }, "httpStatusCode": { "description": "Returned HTTP response code.", "maximum": 599, "minimum": 100, "type": "integer" }, "httpVersion": { "description": "HTTP version used for `curl`.", "minLength": 1, "type": "string" }, "reasonPhrase": { "description": "Reason phrase for the response.", "minLength": 1, "type": "string" }, "responseBody": { "description": "Entire response body.", "minLength": 1, "type": "string" }, "responseHeaderList": { "description": "Collects the response headers in the format `header: value`.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } }, "timing": { "additionalProperties": false, "description": "Collects the time related data.", "type": "object", "required": [ "dnsLookupTime", "tcpConnectionTime", "sslConnectionTime", "timeToFirstByte", "totalTime" ], "properties": { "dnsLookupTime": { "description": "DNS lookup time, in seconds.", "minimum": 0, "type": "number" }, "sslConnectionTime": { "description": "SSL connection time, in seconds.", "minimum": 0, "type": "number" }, "tcpConnectionTime": { "description": "TCP connection time, in seconds.", "minimum": 0, "type": "number" }, "timeToFirstByte": { "description": "Time to first byte, in seconds.", "minimum": 0, "type": "number" }, "totalTime": { "description": "Total time, in seconds.", "minimum": 0, "type": "number" } } } }, "x-akamai": { "file-path": "schemas/curlResults.yaml" } }, "suggestedActions": { "description": "Suggestions on what to do next with the results.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } } }, "x-akamai": { "file-path": "schemas/contentDetail.yaml" } } }, "createdBy": { "description": "Username who submitted the request.", "minLength": 1, "type": "string" }, "createdTime": { "description": "ISO 8601 timestamp indicating when the request was submitted.", "format": "date-time", "type": "string" }, "errorResponse": { "additionalProperties": false, "description": "Specifies the reason for `FAILURE` status.", "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Details about the error.", "minLength": 1, "type": "string" }, "errors": { "description": "Collects information about problems occurred while fetching the data.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } }, "status": { "description": "Error status code.", "minLength": 1, "type": "string" }, "title": { "description": "Error title.", "minLength": 1, "type": "string" }, "type": { "description": "Error type.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/errorResponse.yaml" } }, "executionStatus": { "description": "Status of the request's execution. Possible values are: `SUCCESS`, `FAILURE`, or `IN_PROGRESS`.", "type": "string", "enum": [ "SUCCESS", "FAILURE", "IN_PROGRESS" ] }, "internalIp": { "description": "Machine IP for the requested location used to forward the request to the origin server.", "minLength": 1, "type": "string" }, "internalIpLocation": { "additionalProperties": false, "description": "Specifies the geolocation of `internalIp`.", "type": "object", "required": [ "city", "regionCode", "countryCode", "asNumber" ], "properties": { "asNumber": { "description": "Autonomous System Number the edge IP maps to.", "minimum": 0, "type": "integer" }, "city": { "description": "Closest city within a 50-mile radius the edge IP maps to.", "minLength": 1, "type": "string" }, "countryCode": { "description": "ISO 3166 country code the edge IP maps to.", "minLength": 1, "type": "string" }, "regionCode": { "description": "ISO 3166 region code the edge IP maps to.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/edgeIpLocation.yaml" } }, "link": { "description": "Link to get the Connectivity problems scenario response after the `retryAfter` interval passes. It occurs only for operations with the `IN_PROGRESS` status.", "minLength": 1, "type": "string" }, "logLines": { "description": "Lists the results of the GREP request.", "minItems": 1, "type": "array", "items": { "additionalProperties": false, "description": "Collects fetched logs.", "type": "object", "required": [ "executionContext", "executionStatus" ], "properties": { "errorResponse": { "additionalProperties": false, "description": "Specifies the reason for `FAILURE` status.", "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Details about the error.", "minLength": 1, "type": "string" }, "errors": { "description": "Collects information about problems occurred while fetching the data.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } }, "status": { "description": "Error status code.", "minLength": 1, "type": "string" }, "title": { "description": "Error title.", "minLength": 1, "type": "string" }, "type": { "description": "Error type.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/errorResponse.yaml" } }, "executionContext": { "description": "Execution context. The only possible value is `DEFAULT`. For now, this member doesn't provide any meaningful data.", "type": "string", "enum": [ "DEFAULT" ] }, "executionStatus": { "description": "Status of the GREP request's execution, either `SUCCESS` or `FAILURE`.", "type": "string", "enum": [ "SUCCESS", "FAILURE" ] }, "result": { "additionalProperties": false, "description": "Provides logs fetched with the GREP command.", "type": "object", "required": [ "logs", "legend" ], "properties": { "legend": { "additionalProperties": false, "description": "Descriptions of returned `logType`, `objectStatus`, `objectStatus2`, `objectStatus3` in `r` and `f` log lines.", "type": "object", "required": [ "logType", "rObjectStatus", "rObjectStatus2", "rObjectStatus3", "fObjectStatus", "fObjectStatus2", "fObjectStatus3" ], "properties": { "fObjectStatus": { "description": "Descriptions of the `objectStatus` data in f-line.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } }, "fObjectStatus2": { "description": "Descriptions of the `objectStatus2` data in f-line.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } }, "fObjectStatus3": { "description": "Descriptions of the `objectStatus3` data in f-line.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } }, "logType": { "description": "Description of the `logType` data.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } }, "rObjectStatus": { "description": "Descriptions of the `objectStatus` data in r-line.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } }, "rObjectStatus2": { "description": "Descriptions of the `objectStatus2` data in r-line.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } }, "rObjectStatus3": { "description": "Descriptions of the `objectStatus3` data in r-line.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } } }, "x-akamai": { "file-path": "schemas/legend.yaml" } }, "logs": { "description": "Filtered log lines.", "minItems": 0, "type": "array", "items": { "description": "Items provided as key/value pairs.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } } } }, "x-akamai": { "file-path": "schemas/logsContainer.yaml" } }, "suggestedActions": { "description": "Suggestions on what to do next with the results.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } } }, "x-akamai": { "file-path": "schemas/logLines.yaml" } } }, "request": { "additionalProperties": false, "description": "Specifies your Connectivity problems scenario request.", "type": "object", "required": [ "url" ], "properties": { "clientIp": { "description": "Client IP for the Connectivity problems scenario to start MTR from. You can use the `ip` value from the `edgeIps` array in the [collected diagnostic data](https://techdocs.akamai.com/edge-diagnostics/reference/get-user-diagnostic-data-group-records).", "minLength": 1, "type": "string" }, "edgeLocationId": { "description": "Unique identifier for an edge server location closest to end users experiencing issues with the URL. Run the [List available edge server locations](https://techdocs.akamai.com/edge-diagnostics/reference/get-edge-locations) operation to get this value.", "minLength": 1, "type": "string" }, "ipVersion": { "description": "IP version for the Connectivity problems scenario to use to run cURL and MTR commands, either `IPV4` or `IPV6`.", "type": "string", "enum": [ "IPV4", "IPV6" ] }, "packetType": { "description": "Packet type for the Connectivity problems scenario to use to run MTR, either `ICMP` or `TCP`.", "type": "string", "enum": [ "ICMP", "TCP" ] }, "port": { "description": "Port number for the Connectivity problems scenario to use to run MTR, either `80` or `443`.", "type": "integer", "enum": [ 80, 443 ] }, "requestHeaders": { "description": "Customized headers for the `curl` request in the format `header: value`. The request includes [Akamai Pragma headers](https://techdocs.akamai.com/edge-diagnostics/docs/pragma-headers) by default.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } }, "runFromSiteShield": { "description": "Runs Connectivity problems from a Site Shield map. To learn more, check [Site Shield requests](https://techdocs.akamai.com/edge-diagnostics/reference/site-shield-requests).", "type": "boolean" }, "sensitiveRequestHeaderKeys": { "description": "Sensitive `requestHeaders` you don't want to store in the database after running the request. Check [Sensitive headers](https://techdocs.akamai.com/edge-diagnostics/reference/sensitive-headers) to see the list of request headers treated as sensitive by default.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } }, "spoofEdgeIp": { "description": "IP of the edge server you want to serve traffic from. You can use the `ip` value from the `edgeIps` array in the [collected diagnostic data](https://techdocs.akamai.com/edge-diagnostics/reference/get-user-diagnostic-data-group-records).", "minLength": 1, "type": "string" }, "url": { "description": "URL you want to run the Connectivity problems scenario for.", "format": "uri", "type": "string" } }, "x-akamai": { "file-path": "schemas/connectivityProblemsRequest.yaml" } }, "requestId": { "description": "Unique identifier for the Connectivity problems scenario request. Store this value to run [Get the Connectivity problems scenario response](https://techdocs.akamai.com/edge-diagnostics/reference/get-connectivity-problems-request) operation.", "minimum": 1, "type": "integer" }, "retryAfter": { "description": "Number of seconds when the request is estimated to have processed. It occurs only for operations with the `IN_PROGRESS` status.", "minimum": 1, "type": "integer" }, "siteShieldIp": { "description": "If your request specifies `runFromSiteShield` as `true`, then this IP was used to run Connectivity problems.", "minLength": 1, "type": "string" }, "siteShieldIpLocation": { "additionalProperties": false, "description": "Specifies the geolocation of the edge server used to run the operation.", "type": "object", "required": [ "city", "regionCode", "countryCode", "asNumber" ], "properties": { "asNumber": { "description": "Autonomous System Number the edge IP maps to.", "minimum": 0, "type": "integer" }, "city": { "description": "Closest city within a 50-mile radius the edge IP maps to.", "minLength": 1, "type": "string" }, "countryCode": { "description": "ISO 3166 country code the edge IP maps to.", "minLength": 1, "type": "string" }, "regionCode": { "description": "ISO 3166 region code the edge IP maps to.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/edgeIpLocation.yaml" } }, "spoofEdgeIpLocation": { "additionalProperties": false, "description": "Specifies the geolocation of the edge server used to serve the request.", "type": "object", "required": [ "city", "regionCode", "countryCode", "asNumber" ], "properties": { "asNumber": { "description": "Autonomous System Number the edge IP maps to.", "minimum": 0, "type": "integer" }, "city": { "description": "Closest city within a 50-mile radius the edge IP maps to.", "minLength": 1, "type": "string" }, "countryCode": { "description": "ISO 3166 country code the edge IP maps to.", "minLength": 1, "type": "string" }, "regionCode": { "description": "ISO 3166 region code the edge IP maps to.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/edgeIpLocation.yaml" } }, "summary": { "additionalProperties": false, "description": "Collects partial results of the Connectivity problems scenario. These results contain fetched data that Edge Diagnostics identified as potential source of issues.", "type": "object", "required": [ "content", "logLines", "connectivity" ], "properties": { "connectivity": { "description": "Lists the results of the MTR request.", "minItems": 0, "type": "array", "items": { "additionalProperties": false, "type": "object", "required": [ "executionStatus", "sourceIpLocation", "destinationIpLocation", "sourceContext", "destinationContext", "executionContext" ], "properties": { "additionalRequestParameters": { "additionalProperties": false, "description": "Specifies the MTR request.", "minProperties": 1, "type": "object", "required": [ "source", "destination" ], "properties": { "destination": { "description": "Destination of the request.", "minLength": 1, "type": "string" }, "ipVersion": { "description": "IP version used by the request, either `IPV4` or `IPV6`.", "type": "string", "enum": [ "IPV4", "IPV6" ] }, "packetType": { "description": "Packet type used by the request, either `ICMP` or `TCP`.", "type": "string", "enum": [ "ICMP", "TCP" ] }, "port": { "description": "Port number used by the request, either `80` or `443`.", "type": "integer", "enum": [ 80, 443 ] }, "source": { "description": "Source of the request.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/additionalMtrRequestParameters.yaml" } }, "destinationContext": { "description": "Whether the destination IP is a `CLIENT_IP` or `ORIGIN_IP`.", "type": "string", "enum": [ "ORIGIN_IP", "CLIENT_IP" ] }, "destinationIpLocation": { "additionalProperties": false, "description": "Specifies the geolocation of the origin server IP.", "type": "object", "required": [ "city", "regionCode", "countryCode", "asNumber" ], "properties": { "asNumber": { "description": "Autonomous System Number the edge IP maps to.", "minimum": 0, "type": "integer" }, "city": { "description": "Closest city within a 50-mile radius the edge IP maps to.", "minLength": 1, "type": "string" }, "countryCode": { "description": "ISO 3166 country code the edge IP maps to.", "minLength": 1, "type": "string" }, "regionCode": { "description": "ISO 3166 region code the edge IP maps to.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/edgeIpLocation.yaml" } }, "errorResponse": { "additionalProperties": false, "description": "Specifies the reason for `FAILURE` status.", "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Details about the error.", "minLength": 1, "type": "string" }, "errors": { "description": "Collects information about problems occurred while fetching the data.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } }, "status": { "description": "Error status code.", "minLength": 1, "type": "string" }, "title": { "description": "Error title.", "minLength": 1, "type": "string" }, "type": { "description": "Error type.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/errorResponse.yaml" } }, "executionContext": { "description": "Execution context for MTR. Edge Diagnostics executes MTR between an edge server and the origin server (`EDGE_IP_TO_ORIGIN_IP`) or, if a client IP is present in the request, between an edge server and the client machine (`EDGE_IP_TO_CLIENT_IP`).", "type": "string", "enum": [ "EDGE_IP_TO_ORIGIN_IP", "EDGE_IP_TO_CLIENT_IP" ] }, "executionStatus": { "description": "Status of the MTR request's execution. Possible values are `SUCCESS`, `FAILURE`, or `NOT_EXECUTED`. The `info` member and `FAILURE` in `errorResponse` provide details for `NOT_EXECUTED`.", "type": "string", "enum": [ "SUCCESS", "FAILURE", "NOT_EXECUTED" ] }, "info": { "additionalProperties": false, "description": "Specifies the reason for `NOT_EXECUTED` status.", "type": "object", "required": [ "key", "message" ], "properties": { "key": { "description": "Error key.", "minLength": 1, "type": "string" }, "message": { "description": "Details about the error.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/info.yaml" } }, "result": { "additionalProperties": false, "description": "Standard MTR results.", "type": "object", "required": [ "startTime", "host", "packetLoss", "averageLatency", "hops", "result" ], "properties": { "averageLatency": { "description": "Average latency for all hops, in seconds.", "minimum": 0, "type": "number" }, "hops": { "description": "Lists network hops with their data.", "minItems": 0, "type": "array", "items": { "additionalProperties": false, "description": "Collects network hops with their data.", "type": "object", "required": [ "number", "host", "ip", "ipLocation", "packetLoss", "sentPackets", "lastPacketLatency", "averageLatency", "bestRtt", "worstRtt", "standardDeviation" ], "properties": { "averageLatency": { "description": "Average hop value, useful to detect ongoing problems.", "minimum": 0, "type": "number" }, "bestRtt": { "description": "Fastest time, in milliseconds.", "minimum": 0, "type": "number" }, "host": { "description": "Host or domain name for the hop.", "minLength": 1, "type": "string" }, "ip": { "description": "IP of the hop's `edgeHost`.", "minLength": 1, "type": "string" }, "ipLocation": { "additionalProperties": false, "description": "Geolocation data for the hop's `edgeHost`.", "type": "object", "required": [ "city", "regionCode", "countryCode", "asNumber" ], "properties": { "asNumber": { "description": "Autonomous System Number the edge IP maps to.", "minimum": 0, "type": "integer" }, "city": { "description": "Closest city within a 50-mile radius the edge IP maps to.", "minLength": 1, "type": "string" }, "countryCode": { "description": "ISO 3166 country code the edge IP maps to.", "minLength": 1, "type": "string" }, "regionCode": { "description": "ISO 3166 region code the edge IP maps to.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/edgeIpLocation.yaml" } }, "lastPacketLatency": { "description": "Last measured hop value, useful to detect ongoing problems.", "minimum": 0, "type": "number" }, "number": { "description": "Index for each hop's count within the full set.", "minimum": 0, "type": "integer" }, "packetLoss": { "description": "Percentage of packets lost for the hop, maximum `100`.", "maximum": 100, "minimum": 0, "type": "number" }, "sentPackets": { "description": "Number of packets sent for the hop.", "minimum": 0, "type": "integer" }, "standardDeviation": { "description": "Standard deviation, in milliseconds.", "minimum": 0, "type": "number" }, "worstRtt": { "description": "Slowest time, in milliseconds.", "minimum": 0, "type": "number" } }, "x-akamai": { "file-path": "schemas/mtrHopInstance.yaml" } } }, "host": { "description": "Hostname within the edge network that corresponds to the `source` IP address.", "format": "hostname", "type": "string" }, "packetLoss": { "description": "Percentage of packets lost, maximum `100`.", "maximum": 100, "minimum": 0, "type": "number" }, "result": { "description": "Raw MTR utility output.", "minLength": 1, "type": "string" }, "startTime": { "description": "Epoch timestamp marking when MTR was run.", "type": "integer" } }, "x-akamai": { "file-path": "schemas/mtrData.yaml" } }, "sourceContext": { "description": "Context for MTR source. The source can be either an edge server forwarding the request to the origin server (`EDGE_IP_CONNECTED_TO_ORIGIN`) or an edge server in the location (`EDGE_IP_BASED_ON_LOCATION`), either selected randomly or provided in the request.", "type": "string", "enum": [ "EDGE_IP_CONNECTED_TO_ORIGIN", "EDGE_IP_BASED_ON_LOCATION" ] }, "sourceIpLocation": { "additionalProperties": false, "description": "Specifies the geolocation of the source IP.", "type": "object", "required": [ "city", "regionCode", "countryCode", "asNumber" ], "properties": { "asNumber": { "description": "Autonomous System Number the edge IP maps to.", "minimum": 0, "type": "integer" }, "city": { "description": "Closest city within a 50-mile radius the edge IP maps to.", "minLength": 1, "type": "string" }, "countryCode": { "description": "ISO 3166 country code the edge IP maps to.", "minLength": 1, "type": "string" }, "regionCode": { "description": "ISO 3166 region code the edge IP maps to.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/edgeIpLocation.yaml" } }, "suggestedActions": { "description": "Suggestions on what to do next with the results.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } } }, "x-akamai": { "file-path": "schemas/connectivity.yaml" } } }, "content": { "description": "Lists the results of the cURL request.", "minItems": 0, "type": "array", "items": { "additionalProperties": false, "type": "object", "required": [ "executionContext", "executionStatus" ], "properties": { "additionalRequestParameters": { "additionalProperties": false, "description": "Specifies the cURL request.", "minProperties": 1, "type": "object", "properties": { "includeDefaultPragmaHeaders": { "description": "Indicates whether the request included the default list of `Pragma` headers. Check [Pragma headers](https://techdocs.akamai.com/edge-diagnostics/docs/pragma-headers) to learn about default Akamai Pragma headers.", "type": "boolean" }, "ipVersion": { "description": "IP version used by the request, either `IPV4` or `IPV6`.", "type": "string", "enum": [ "IPV4", "IPV6" ] }, "requestHeaders": { "description": "Customized headers for `curl` request in the format `header: value`.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } } }, "x-akamai": { "file-path": "schemas/additionalCurlRequestParameters.yaml" } }, "errorResponse": { "additionalProperties": false, "description": "Specifies the reason for `FAILURE` status.", "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Details about the error.", "minLength": 1, "type": "string" }, "errors": { "description": "Collects information about problems occurred while fetching the data.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } }, "status": { "description": "Error status code.", "minLength": 1, "type": "string" }, "title": { "description": "Error title.", "minLength": 1, "type": "string" }, "type": { "description": "Error type.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/errorResponse.yaml" } }, "executionContext": { "description": "Execution context. The only possible value is `DEFAULT`. For now, this member doesn't provide any meaningful data.", "type": "string", "enum": [ "DEFAULT" ] }, "executionStatus": { "description": "Status of the cURL request's execution, either `SUCCESS` or `FAILURE`.", "type": "string", "enum": [ "SUCCESS", "FAILURE" ] }, "result": { "additionalProperties": false, "description": "Results of the `curl` command.", "minProperties": 1, "type": "object", "required": [ "exitCode" ], "properties": { "exitCode": { "description": "Curl command exit code. [List of possible curl exit code.](https://curl.se/libcurl/c/libcurl-errors.html) ", "minimum": 0, "type": "integer" }, "httpStatusCode": { "description": "Returned HTTP response code.", "maximum": 599, "minimum": 100, "type": "integer" }, "httpVersion": { "description": "HTTP version used for `curl`.", "minLength": 1, "type": "string" }, "reasonPhrase": { "description": "Reason phrase for the response.", "minLength": 1, "type": "string" }, "responseBody": { "description": "Entire response body.", "minLength": 1, "type": "string" }, "responseHeaderList": { "description": "Collects the response headers in the format `header: value`.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } }, "timing": { "additionalProperties": false, "description": "Collects the time related data.", "type": "object", "required": [ "dnsLookupTime", "tcpConnectionTime", "sslConnectionTime", "timeToFirstByte", "totalTime" ], "properties": { "dnsLookupTime": { "description": "DNS lookup time, in seconds.", "minimum": 0, "type": "number" }, "sslConnectionTime": { "description": "SSL connection time, in seconds.", "minimum": 0, "type": "number" }, "tcpConnectionTime": { "description": "TCP connection time, in seconds.", "minimum": 0, "type": "number" }, "timeToFirstByte": { "description": "Time to first byte, in seconds.", "minimum": 0, "type": "number" }, "totalTime": { "description": "Total time, in seconds.", "minimum": 0, "type": "number" } } } }, "x-akamai": { "file-path": "schemas/curlResults.yaml" } }, "suggestedActions": { "description": "Suggestions on what to do next with the results.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } } }, "x-akamai": { "file-path": "schemas/contentDetail.yaml" } } }, "logLines": { "description": "Lists the results of the GREP request.", "minItems": 0, "type": "array", "items": { "additionalProperties": false, "description": "Collects fetched logs.", "type": "object", "required": [ "executionContext", "executionStatus" ], "properties": { "errorResponse": { "additionalProperties": false, "description": "Specifies the reason for `FAILURE` status.", "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Details about the error.", "minLength": 1, "type": "string" }, "errors": { "description": "Collects information about problems occurred while fetching the data.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } }, "status": { "description": "Error status code.", "minLength": 1, "type": "string" }, "title": { "description": "Error title.", "minLength": 1, "type": "string" }, "type": { "description": "Error type.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/errorResponse.yaml" } }, "executionContext": { "description": "Execution context. The only possible value is `DEFAULT`. For now, this member doesn't provide any meaningful data.", "type": "string", "enum": [ "DEFAULT" ] }, "executionStatus": { "description": "Status of the GREP request's execution, either `SUCCESS` or `FAILURE`.", "type": "string", "enum": [ "SUCCESS", "FAILURE" ] }, "result": { "additionalProperties": false, "description": "Provides logs fetched with the GREP command.", "type": "object", "required": [ "logs", "legend" ], "properties": { "legend": { "additionalProperties": false, "description": "Descriptions of returned `logType`, `objectStatus`, `objectStatus2`, `objectStatus3` in `r` and `f` log lines.", "type": "object", "required": [ "logType", "rObjectStatus", "rObjectStatus2", "rObjectStatus3", "fObjectStatus", "fObjectStatus2", "fObjectStatus3" ], "properties": { "fObjectStatus": { "description": "Descriptions of the `objectStatus` data in f-line.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } }, "fObjectStatus2": { "description": "Descriptions of the `objectStatus2` data in f-line.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } }, "fObjectStatus3": { "description": "Descriptions of the `objectStatus3` data in f-line.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } }, "logType": { "description": "Description of the `logType` data.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } }, "rObjectStatus": { "description": "Descriptions of the `objectStatus` data in r-line.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } }, "rObjectStatus2": { "description": "Descriptions of the `objectStatus2` data in r-line.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } }, "rObjectStatus3": { "description": "Descriptions of the `objectStatus3` data in r-line.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } } }, "x-akamai": { "file-path": "schemas/legend.yaml" } }, "logs": { "description": "Filtered log lines.", "minItems": 0, "type": "array", "items": { "description": "Items provided as key/value pairs.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } } } }, "x-akamai": { "file-path": "schemas/logsContainer.yaml" } }, "suggestedActions": { "description": "Suggestions on what to do next with the results.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } } }, "x-akamai": { "file-path": "schemas/logLines.yaml" } } } }, "x-akamai": { "file-path": "schemas/connectivityProblemsSummary.yaml" } } }, "x-akamai": { "file-path": "schemas/connectivityProblemsResponse.yaml" } } } }, "headers": { "X-RateLimit-Limit": { "description": "The rate limit ceiling for this endpoint.", "example": 10, "schema": { "type": "integer" }, "x-akamai": { "file-path": "headers/X-RateLimit-Limit.yaml" } }, "X-RateLimit-Remaining": { "description": "The number of requests left for the time window.", "example": 5, "schema": { "type": "integer" }, "x-akamai": { "file-path": "headers/X-RateLimit-Remaining.yaml" } } } }, "401": { "description": "[Authorization error](https://techdocs.akamai.com/edge-diagnostics/reference/401).", "content": { "application/problem+json": { "example": { "detail": "Inactive client token", "instance": "https://akab-nedrvuylepskzabx-lv3dgceqqktx3i5b.luna.akamaiapis.net/edge-diagnostics/v1/grep/requests", "status": 401, "title": "Not authorized", "type": "https://problems.luna.akamaiapis.net/-/pep-authn/deny" }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/401.yaml" } }, "403": { "description": "[Permission error](https://techdocs.akamai.com/edge-diagnostics/reference/403).", "content": { "application/problem+json": { "example": { "status": 403, "title": "Forbidden request.", "type": "forbidden.request.error", "errors": [ { "detail": "You don't have access to the requested URL. Contact your Admin to request access.", "requestField": "url", "title": "Field access denied.", "type": "field.access.denied" } ] }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/403.yaml" } }, "404": { "description": "[Resource not found error](https://techdocs.akamai.com/edge-diagnostics/reference/404).", "content": { "application/problem+json": { "example": { "detail": "The requested resource couldn't be found. Make sure that the resource is not deleted and the ID is correct.", "status": 404, "title": "Resource not found.", "type": "resource.not.found" }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/404.yaml" } }, "405": { "description": "[Method not allowed](https://techdocs.akamai.com/edge-diagnostics/reference/405).", "content": { "application/problem+json": { "example": { "title": "Method not allowed", "type": "method.not.allowed" }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/405.yaml" } }, "429": { "description": "[Too many requests](https://techdocs.akamai.com/edge-diagnostics/reference/429).", "content": { "application/problem+json": { "example": { "detail": "You have exceeded total number of requests configured for this API.", "status": 429, "title": "Too Many Requests", "type": "requests.exceeded.error" }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/429.yaml" } } }, "parameters": [ { "description": "Includes response bodies in the response.", "example": "{{includeContentResponseBody}}", "in": "query", "name": "includeContentResponseBody", "schema": { "example": false, "type": "boolean" }, "x-akamai": { "file-path": "parameters/includeContentResponseBody-query.yaml" } }, { "description": "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ] }, "parameters": [ { "description": "Unique identifier for a request. To get this value, run the corresponding POST operation.", "example": "{{requestId}}", "in": "path", "name": "requestId", "required": true, "schema": { "example": 365, "type": "integer" }, "x-akamai": { "file-path": "parameters/requestId-path.yaml" } } ] }, "/content-problems": { "post": { "description": "Launches an [asynchronous](https://techdocs.akamai.com/edge-diagnostics/reference/asynchronous-processes) request to simultaneously run [Launch a GREP request](https://techdocs.akamai.com/edge-diagnostics/reference/post-grep) and [Request content with cURL](https://techdocs.akamai.com/edge-diagnostics/reference/post-curl) operations for a URL. It may help you diagnose issues with slow download and high response time. Successful operations return fetched GREP and cURL data.", "operationId": "post-content-problems", "summary": "Run the content problems scenario", "tags": [ "Content problems" ], "externalDocs": { "description": "See documentation for this operation in Akamai's Edge Diagnostics API", "url": "https://techdocs.akamai.com/edge-diagnostics/reference/post-content-problems" }, "requestBody": { "required": false, "content": { "application/json": { "example": { "edgeLocationId": "allen-tx-unitedregionCodes", "ipVersion": "IPV4", "spoofEdgeIp": "192.0.2.9", "url": "http://www.atcuser15.akamaiu.com", "requestHeaders": [ "Accept-Language: en-US" ] }, "schema": { "additionalProperties": false, "description": "Collects data to use in the Content problems scenario request.", "type": "object", "required": [ "url" ], "properties": { "edgeLocationId": { "description": "Unique identifier for an edge server location closest to end users experiencing issues with the URL. Run the [List available edge server locations](https://techdocs.akamai.com/edge-diagnostics/reference/get-edge-locations) operation to get this value.", "example": "{{edgeLocationId}}", "minLength": 1, "type": "string" }, "ipVersion": { "description": "IP version for the Content problems scenario to use to run cURL and MTR commands, either `IPV4` or `IPV6`.", "example": "{{ipVersion}}", "type": "string", "enum": [ "IPV4", "IPV6" ] }, "requestHeaders": { "description": "Customized headers for the `curl` request in the format `header: value`. The request includes [Akamai Pragma headers](https://techdocs.akamai.com/edge-diagnostics/docs/pragma-headers) by default.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } }, "runFromSiteShield": { "description": "Runs Content problems from a Site Shield map. To learn more, check [Site Shield requests](https://techdocs.akamai.com/edge-diagnostics/reference/site-shield-requests).", "example": "{{runFromSiteShield}}", "type": "boolean" }, "sensitiveRequestHeaderKeys": { "description": "Sensitive `requestHeaders` you don't want to store in the database after running the request. Check [Sensitive headers](https://techdocs.akamai.com/edge-diagnostics/reference/sensitive-headers) to see the list of request headers treated as sensitive by default.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } }, "spoofEdgeIp": { "description": "IP of the edge server you want to serve traffic from. You can use the `ip` value from the `edgeIps` array in the [collected diagnostic data](https://techdocs.akamai.com/edge-diagnostics/reference/get-user-diagnostic-data-group-records).", "example": "{{spoofEdgeIp}}", "minLength": 1, "type": "string" }, "url": { "description": "URL you want to run the Content problems scenario for.", "example": "{{url}}", "format": "uri", "type": "string" } }, "x-akamai": { "file-path": "schemas/contentProblemsRequest.yaml" } } } } }, "responses": { "202": { "description": "Process successfully launched.", "content": { "application/json": { "example": { "createdBy": "jkowalski", "createdTime": "2021-11-26T13:41:07Z", "executionStatus": "SUCCESS", "internalIp": "192.0.2.17", "requestId": 365, "internalIpLocation": { "asNumber": 20940, "city": "ADELAIDE", "countryCode": "AU", "regionCode": "SA" }, "request": { "edgeLocationId": "adelaide-sa-australia", "ipVersion": "IPV4", "spoofEdgeIp": "192.0.2.9", "url": "https://www.example.com", "requestHeaders": [ "Test: Test" ] }, "spoofEdgeIpLocation": { "asNumber": 20940, "city": "MUMBAI", "countryCode": "IN", "regionCode": "MH" }, "summary": { "content": [ { "executionContext": "DEFAULT", "executionStatus": "SUCCESS", "suggestedActions": [ "Compare the response headers served from edge and origin.", "Check for content correctness.", "Check content length/bytes served." ], "additionalRequestParameters": { "includeDefaultPragmaHeaders": true }, "result": { "responseHeaderList": [] } } ], "logLines": [ { "executionContext": "DEFAULT", "executionStatus": "SUCCESS", "suggestedActions": [ "Check content length/bytes served." ], "result": { "legend": { "fObjectStatus": { "D": "A default object was served.", "a": "This response was sent through the ESI processor.", "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." }, "fObjectStatus2": {}, "fObjectStatus3": {}, "logType": { "f": "(f) going forward to forward hostname" }, "rObjectStatus": {}, "rObjectStatus2": {}, "rObjectStatus3": {} }, "logs": [ { "clientIp": "192.0.2.17", "contentBytesServed": "-", "edgeIp": "192.0.2.14", "forwardIp": "192.0.2.18", "logType": "f", "objectStatus": "oaDx", "timeTaken": "0", "turnaroundTime": "3494" } ] } } ] }, "content": [ { "executionContext": "DEFAULT", "executionStatus": "SUCCESS", "suggestedActions": [ "Compare the response headers served from edge and origin.", "Check for content correctness.", "Check content length/bytes served." ], "additionalRequestParameters": { "includeDefaultPragmaHeaders": true }, "result": { "httpStatusCode": 200, "httpVersion": "HTTP/1.1", "reasonPhrase": "OK", "responseHeaderList": [ "Transfer-Encoding: chunked", "X-Cache: TCP_MISS from a23-212-50-38.deploy.akamaitechnologies.com (AkamaiGHost/10.4.6-37171458) (-)", "Content-Type: text/html; charset=UTF-8", "X-Powered-By: PHP/7.3.2" ], "timing": { "dnsLookupTime": 1.509502, "sslConnectionTime": 0, "tcpConnectionTime": 1.524193, "timeToFirstByte": 1.555875, "totalTime": 2.091051 } } } ], "logLines": [ { "executionContext": "DEFAULT", "executionStatus": "SUCCESS", "suggestedActions": [ "Check content length/bytes served." ], "result": { "legend": { "fObjectStatus": { "D": "A default object was served.", "a": "This response was sent through the ESI processor.", "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." }, "fObjectStatus2": {}, "fObjectStatus3": {}, "logType": { "f": "(f) going forward to forward hostname" }, "rObjectStatus": {}, "rObjectStatus2": {}, "rObjectStatus3": {} }, "logs": [ { "arl": "/D/16382/474258/000/origin-www.example.com/%20vcd=1360", "bytesReceived": "21154", "bytesServed": "-", "clientIp": "192.0.2.17", "contentBytesServed": "-", "contentType": "text/html", "cookie": "-", "cpCode": "1234567", "dateTime": "2021-11-26T13:41:18.014Z", "edgeIp": "192.0.2.14", "error": "-", "forwardHostname": "origin-www.example.com", "forwardIp": "192.0.2.18", "hostHeader": "-", "httpMethod": "GET", "httpStatus": "200", "logType": "f", "objectSize": "-", "objectStatus": "oaDx", "objectStatus2": "-", "objectStatus3": "-", "referer": "-", "sslVersion": "TLSv1.2", "timeTaken": "0", "turnaroundTime": "3494", "userAgent": "-" } ] } } ] }, "schema": { "additionalProperties": false, "description": "Collects the Content problems scenario results and details about the request.", "type": "object", "required": [ "summary", "content", "request", "requestId", "executionStatus", "createdBy", "createdTime", "internalIp", "internalIpLocation", "logLines" ], "properties": { "content": { "description": "Lists the results of the cURL request.", "minItems": 1, "type": "array", "items": { "additionalProperties": false, "type": "object", "required": [ "executionContext", "executionStatus" ], "properties": { "additionalRequestParameters": { "additionalProperties": false, "description": "Specifies the cURL request.", "minProperties": 1, "type": "object", "properties": { "includeDefaultPragmaHeaders": { "description": "Indicates whether the request included the default list of `Pragma` headers. Check [Pragma headers](https://techdocs.akamai.com/edge-diagnostics/docs/pragma-headers) to learn about default Akamai Pragma headers.", "type": "boolean" }, "ipVersion": { "description": "IP version used by the request, either `IPV4` or `IPV6`.", "type": "string", "enum": [ "IPV4", "IPV6" ] }, "requestHeaders": { "description": "Customized headers for `curl` request in the format `header: value`.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } } }, "x-akamai": { "file-path": "schemas/additionalCurlRequestParameters.yaml" } }, "errorResponse": { "additionalProperties": false, "description": "Specifies the reason for `FAILURE` status.", "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Details about the error.", "minLength": 1, "type": "string" }, "errors": { "description": "Collects information about problems occurred while fetching the data.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } }, "status": { "description": "Error status code.", "minLength": 1, "type": "string" }, "title": { "description": "Error title.", "minLength": 1, "type": "string" }, "type": { "description": "Error type.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/errorResponse.yaml" } }, "executionContext": { "description": "Execution context. The only possible value is `DEFAULT`. For now, this member doesn't provide any meaningful data.", "type": "string", "enum": [ "DEFAULT" ] }, "executionStatus": { "description": "Status of the cURL request's execution, either `SUCCESS` or `FAILURE`.", "type": "string", "enum": [ "SUCCESS", "FAILURE" ] }, "result": { "additionalProperties": false, "description": "Results of the `curl` command.", "minProperties": 1, "type": "object", "required": [ "exitCode" ], "properties": { "exitCode": { "description": "Curl command exit code. [List of possible curl exit code.](https://curl.se/libcurl/c/libcurl-errors.html) ", "minimum": 0, "type": "integer" }, "httpStatusCode": { "description": "Returned HTTP response code.", "maximum": 599, "minimum": 100, "type": "integer" }, "httpVersion": { "description": "HTTP version used for `curl`.", "minLength": 1, "type": "string" }, "reasonPhrase": { "description": "Reason phrase for the response.", "minLength": 1, "type": "string" }, "responseBody": { "description": "Entire response body.", "minLength": 1, "type": "string" }, "responseHeaderList": { "description": "Collects the response headers in the format `header: value`.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } }, "timing": { "additionalProperties": false, "description": "Collects the time related data.", "type": "object", "required": [ "dnsLookupTime", "tcpConnectionTime", "sslConnectionTime", "timeToFirstByte", "totalTime" ], "properties": { "dnsLookupTime": { "description": "DNS lookup time, in seconds.", "minimum": 0, "type": "number" }, "sslConnectionTime": { "description": "SSL connection time, in seconds.", "minimum": 0, "type": "number" }, "tcpConnectionTime": { "description": "TCP connection time, in seconds.", "minimum": 0, "type": "number" }, "timeToFirstByte": { "description": "Time to first byte, in seconds.", "minimum": 0, "type": "number" }, "totalTime": { "description": "Total time, in seconds.", "minimum": 0, "type": "number" } } } }, "x-akamai": { "file-path": "schemas/curlResults.yaml" } }, "suggestedActions": { "description": "Suggestions on what to do next with the results.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } } }, "x-akamai": { "file-path": "schemas/contentDetail.yaml" } } }, "createdBy": { "description": "Username who submitted the request.", "minLength": 1, "type": "string" }, "createdTime": { "description": "ISO 8601 timestamp indicating when the request was submitted.", "format": "date-time", "type": "string" }, "errorResponse": { "additionalProperties": false, "description": "Specifies the reason for `FAILURE` status.", "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Details about the error.", "minLength": 1, "type": "string" }, "errors": { "description": "Collects information about problems occurred while fetching the data.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } }, "status": { "description": "Error status code.", "minLength": 1, "type": "string" }, "title": { "description": "Error title.", "minLength": 1, "type": "string" }, "type": { "description": "Error type.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/errorResponse.yaml" } }, "executionStatus": { "description": "Status of the request's execution. Possible values are: `SUCCESS`, `FAILURE`, or `IN_PROGRESS`.", "type": "string", "enum": [ "SUCCESS", "FAILURE", "IN_PROGRESS" ] }, "internalIp": { "description": "Machine IP for the requested location used to forward the request to the origin server.", "minLength": 1, "type": "string" }, "internalIpLocation": { "additionalProperties": false, "description": "Specifies the geolocation of `internalIp`.", "type": "object", "required": [ "city", "regionCode", "countryCode", "asNumber" ], "properties": { "asNumber": { "description": "Autonomous System Number the edge IP maps to.", "minimum": 0, "type": "integer" }, "city": { "description": "Closest city within a 50-mile radius the edge IP maps to.", "minLength": 1, "type": "string" }, "countryCode": { "description": "ISO 3166 country code the edge IP maps to.", "minLength": 1, "type": "string" }, "regionCode": { "description": "ISO 3166 region code the edge IP maps to.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/edgeIpLocation.yaml" } }, "link": { "description": "Link to get the Content problems scenario response after the `retryAfter` interval passes. It occurs only for operations with the `IN_PROGRESS` status.", "minLength": 1, "type": "string" }, "logLines": { "description": "Lists the results of the GREP request.", "minItems": 1, "type": "array", "items": { "additionalProperties": false, "description": "Collects fetched logs.", "type": "object", "required": [ "executionContext", "executionStatus" ], "properties": { "errorResponse": { "additionalProperties": false, "description": "Specifies the reason for `FAILURE` status.", "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Details about the error.", "minLength": 1, "type": "string" }, "errors": { "description": "Collects information about problems occurred while fetching the data.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } }, "status": { "description": "Error status code.", "minLength": 1, "type": "string" }, "title": { "description": "Error title.", "minLength": 1, "type": "string" }, "type": { "description": "Error type.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/errorResponse.yaml" } }, "executionContext": { "description": "Execution context. The only possible value is `DEFAULT`. For now, this member doesn't provide any meaningful data.", "type": "string", "enum": [ "DEFAULT" ] }, "executionStatus": { "description": "Status of the GREP request's execution, either `SUCCESS` or `FAILURE`.", "type": "string", "enum": [ "SUCCESS", "FAILURE" ] }, "result": { "additionalProperties": false, "description": "Provides logs fetched with the GREP command.", "type": "object", "required": [ "logs", "legend" ], "properties": { "legend": { "additionalProperties": false, "description": "Descriptions of returned `logType`, `objectStatus`, `objectStatus2`, `objectStatus3` in `r` and `f` log lines.", "type": "object", "required": [ "logType", "rObjectStatus", "rObjectStatus2", "rObjectStatus3", "fObjectStatus", "fObjectStatus2", "fObjectStatus3" ], "properties": { "fObjectStatus": { "description": "Descriptions of the `objectStatus` data in f-line.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } }, "fObjectStatus2": { "description": "Descriptions of the `objectStatus2` data in f-line.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } }, "fObjectStatus3": { "description": "Descriptions of the `objectStatus3` data in f-line.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } }, "logType": { "description": "Description of the `logType` data.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } }, "rObjectStatus": { "description": "Descriptions of the `objectStatus` data in r-line.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } }, "rObjectStatus2": { "description": "Descriptions of the `objectStatus2` data in r-line.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } }, "rObjectStatus3": { "description": "Descriptions of the `objectStatus3` data in r-line.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } } }, "x-akamai": { "file-path": "schemas/legend.yaml" } }, "logs": { "description": "Filtered log lines.", "minItems": 0, "type": "array", "items": { "description": "Items provided as key/value pairs.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } } } }, "x-akamai": { "file-path": "schemas/logsContainer.yaml" } }, "suggestedActions": { "description": "Suggestions on what to do next with the results.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } } }, "x-akamai": { "file-path": "schemas/logLines.yaml" } } }, "request": { "additionalProperties": false, "description": "Specifies your Content problems scenario request.", "type": "object", "required": [ "url" ], "properties": { "edgeLocationId": { "description": "Unique identifier for an edge server location closest to end users experiencing issues with the URL. Run the [List available edge server locations](https://techdocs.akamai.com/edge-diagnostics/reference/get-edge-locations) operation to get this value.", "minLength": 1, "type": "string" }, "ipVersion": { "description": "IP version for the Content problems scenario to use to run cURL and MTR commands, either `IPV4` or `IPV6`.", "type": "string", "enum": [ "IPV4", "IPV6" ] }, "requestHeaders": { "description": "Customized headers for the `curl` request in the format `header: value`. The request includes [Akamai Pragma headers](https://techdocs.akamai.com/edge-diagnostics/docs/pragma-headers) by default.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } }, "runFromSiteShield": { "description": "Runs Content problems from a Site Shield map. To learn more, check [Site Shield requests](https://techdocs.akamai.com/edge-diagnostics/reference/site-shield-requests).", "type": "boolean" }, "sensitiveRequestHeaderKeys": { "description": "Sensitive `requestHeaders` you don't want to store in the database after running the request. Check [Sensitive headers](https://techdocs.akamai.com/edge-diagnostics/reference/sensitive-headers) to see the list of request headers treated as sensitive by default.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } }, "spoofEdgeIp": { "description": "IP of the edge server you want to serve traffic from. You can use the `ip` value from the `edgeIps` array in the [collected diagnostic data](https://techdocs.akamai.com/edge-diagnostics/reference/get-user-diagnostic-data-group-records).", "minLength": 1, "type": "string" }, "url": { "description": "URL you want to run the Content problems scenario for.", "format": "uri", "type": "string" } }, "x-akamai": { "file-path": "schemas/contentProblemsRequest.yaml" } }, "requestId": { "description": "Unique identifier for the Content problems scenario request. Store this value to run the [Get the Content problems scenario response](https://techdocs.akamai.com/edge-diagnostics/reference/get-content-problems) operation.", "minimum": 0, "type": "integer" }, "retryAfter": { "description": "Number of seconds when the request is estimated to have processed. It occurs only for operations with the `IN_PROGRESS` status.", "minimum": 0, "type": "integer" }, "siteShieldIp": { "description": "If your request specifies `runFromSiteShield` as `true`, then this IP is used to run Content problems.", "minLength": 1, "type": "string" }, "siteShieldIpLocation": { "additionalProperties": false, "description": "Specifies the geolocation of the edge server used to run the operation.", "type": "object", "required": [ "city", "regionCode", "countryCode", "asNumber" ], "properties": { "asNumber": { "description": "Autonomous System Number the edge IP maps to.", "minimum": 0, "type": "integer" }, "city": { "description": "Closest city within a 50-mile radius the edge IP maps to.", "minLength": 1, "type": "string" }, "countryCode": { "description": "ISO 3166 country code the edge IP maps to.", "minLength": 1, "type": "string" }, "regionCode": { "description": "ISO 3166 region code the edge IP maps to.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/edgeIpLocation.yaml" } }, "spoofEdgeIpLocation": { "additionalProperties": false, "description": "Specifies the geolocation of the edge server used to serve the request.", "type": "object", "required": [ "city", "regionCode", "countryCode", "asNumber" ], "properties": { "asNumber": { "description": "Autonomous System Number the edge IP maps to.", "minimum": 0, "type": "integer" }, "city": { "description": "Closest city within a 50-mile radius the edge IP maps to.", "minLength": 1, "type": "string" }, "countryCode": { "description": "ISO 3166 country code the edge IP maps to.", "minLength": 1, "type": "string" }, "regionCode": { "description": "ISO 3166 region code the edge IP maps to.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/edgeIpLocation.yaml" } }, "summary": { "additionalProperties": false, "description": "Collects partial results of the Content problems scenario. These results contain fetched data that Edge Diagnostics identified as potential source of issues.", "type": "object", "required": [ "content", "logLines" ], "properties": { "content": { "description": "Lists the results of the cURL request.", "minItems": 0, "type": "array", "items": { "additionalProperties": false, "type": "object", "required": [ "executionContext", "executionStatus" ], "properties": { "additionalRequestParameters": { "additionalProperties": false, "description": "Specifies the cURL request.", "minProperties": 1, "type": "object", "properties": { "includeDefaultPragmaHeaders": { "description": "Indicates whether the request included the default list of `Pragma` headers. Check [Pragma headers](https://techdocs.akamai.com/edge-diagnostics/docs/pragma-headers) to learn about default Akamai Pragma headers.", "type": "boolean" }, "ipVersion": { "description": "IP version used by the request, either `IPV4` or `IPV6`.", "type": "string", "enum": [ "IPV4", "IPV6" ] }, "requestHeaders": { "description": "Customized headers for `curl` request in the format `header: value`.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } } }, "x-akamai": { "file-path": "schemas/additionalCurlRequestParameters.yaml" } }, "errorResponse": { "additionalProperties": false, "description": "Specifies the reason for `FAILURE` status.", "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Details about the error.", "minLength": 1, "type": "string" }, "errors": { "description": "Collects information about problems occurred while fetching the data.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } }, "status": { "description": "Error status code.", "minLength": 1, "type": "string" }, "title": { "description": "Error title.", "minLength": 1, "type": "string" }, "type": { "description": "Error type.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/errorResponse.yaml" } }, "executionContext": { "description": "Execution context. The only possible value is `DEFAULT`. For now, this member doesn't provide any meaningful data.", "type": "string", "enum": [ "DEFAULT" ] }, "executionStatus": { "description": "Status of the cURL request's execution, either `SUCCESS` or `FAILURE`.", "type": "string", "enum": [ "SUCCESS", "FAILURE" ] }, "result": { "additionalProperties": false, "description": "Results of the `curl` command.", "minProperties": 1, "type": "object", "required": [ "exitCode" ], "properties": { "exitCode": { "description": "Curl command exit code. [List of possible curl exit code.](https://curl.se/libcurl/c/libcurl-errors.html) ", "minimum": 0, "type": "integer" }, "httpStatusCode": { "description": "Returned HTTP response code.", "maximum": 599, "minimum": 100, "type": "integer" }, "httpVersion": { "description": "HTTP version used for `curl`.", "minLength": 1, "type": "string" }, "reasonPhrase": { "description": "Reason phrase for the response.", "minLength": 1, "type": "string" }, "responseBody": { "description": "Entire response body.", "minLength": 1, "type": "string" }, "responseHeaderList": { "description": "Collects the response headers in the format `header: value`.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } }, "timing": { "additionalProperties": false, "description": "Collects the time related data.", "type": "object", "required": [ "dnsLookupTime", "tcpConnectionTime", "sslConnectionTime", "timeToFirstByte", "totalTime" ], "properties": { "dnsLookupTime": { "description": "DNS lookup time, in seconds.", "minimum": 0, "type": "number" }, "sslConnectionTime": { "description": "SSL connection time, in seconds.", "minimum": 0, "type": "number" }, "tcpConnectionTime": { "description": "TCP connection time, in seconds.", "minimum": 0, "type": "number" }, "timeToFirstByte": { "description": "Time to first byte, in seconds.", "minimum": 0, "type": "number" }, "totalTime": { "description": "Total time, in seconds.", "minimum": 0, "type": "number" } } } }, "x-akamai": { "file-path": "schemas/curlResults.yaml" } }, "suggestedActions": { "description": "Suggestions on what to do next with the results.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } } }, "x-akamai": { "file-path": "schemas/contentDetail.yaml" } } }, "logLines": { "description": "Lists the results of the GREP request.", "minItems": 0, "type": "array", "items": { "additionalProperties": false, "description": "Collects fetched logs.", "type": "object", "required": [ "executionContext", "executionStatus" ], "properties": { "errorResponse": { "additionalProperties": false, "description": "Specifies the reason for `FAILURE` status.", "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Details about the error.", "minLength": 1, "type": "string" }, "errors": { "description": "Collects information about problems occurred while fetching the data.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } }, "status": { "description": "Error status code.", "minLength": 1, "type": "string" }, "title": { "description": "Error title.", "minLength": 1, "type": "string" }, "type": { "description": "Error type.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/errorResponse.yaml" } }, "executionContext": { "description": "Execution context. The only possible value is `DEFAULT`. For now, this member doesn't provide any meaningful data.", "type": "string", "enum": [ "DEFAULT" ] }, "executionStatus": { "description": "Status of the GREP request's execution, either `SUCCESS` or `FAILURE`.", "type": "string", "enum": [ "SUCCESS", "FAILURE" ] }, "result": { "additionalProperties": false, "description": "Provides logs fetched with the GREP command.", "type": "object", "required": [ "logs", "legend" ], "properties": { "legend": { "additionalProperties": false, "description": "Descriptions of returned `logType`, `objectStatus`, `objectStatus2`, `objectStatus3` in `r` and `f` log lines.", "type": "object", "required": [ "logType", "rObjectStatus", "rObjectStatus2", "rObjectStatus3", "fObjectStatus", "fObjectStatus2", "fObjectStatus3" ], "properties": { "fObjectStatus": { "description": "Descriptions of the `objectStatus` data in f-line.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } }, "fObjectStatus2": { "description": "Descriptions of the `objectStatus2` data in f-line.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } }, "fObjectStatus3": { "description": "Descriptions of the `objectStatus3` data in f-line.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } }, "logType": { "description": "Description of the `logType` data.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } }, "rObjectStatus": { "description": "Descriptions of the `objectStatus` data in r-line.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } }, "rObjectStatus2": { "description": "Descriptions of the `objectStatus2` data in r-line.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } }, "rObjectStatus3": { "description": "Descriptions of the `objectStatus3` data in r-line.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } } }, "x-akamai": { "file-path": "schemas/legend.yaml" } }, "logs": { "description": "Filtered log lines.", "minItems": 0, "type": "array", "items": { "description": "Items provided as key/value pairs.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } } } }, "x-akamai": { "file-path": "schemas/logsContainer.yaml" } }, "suggestedActions": { "description": "Suggestions on what to do next with the results.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } } }, "x-akamai": { "file-path": "schemas/logLines.yaml" } } } }, "x-akamai": { "file-path": "schemas/contentProblemsSummary.yaml" } } }, "x-akamai": { "file-path": "schemas/contentProblemsResponse.yaml" } } } }, "headers": { "X-RateLimit-Limit": { "description": "The rate limit ceiling for this endpoint.", "example": 10, "schema": { "type": "integer" }, "x-akamai": { "file-path": "headers/X-RateLimit-Limit.yaml" } }, "X-RateLimit-Remaining": { "description": "The number of requests left for the time window.", "example": 5, "schema": { "type": "integer" }, "x-akamai": { "file-path": "headers/X-RateLimit-Remaining.yaml" } } } }, "400": { "description": "[Validation error](https://techdocs.akamai.com/edge-diagnostics/reference/400).", "content": { "application/problem+json": { "example": { "detail": "Provide only one of these members, either `edgeLocationId` or `edgeIp`.", "status": 400, "title": "Incorrect request.", "type": "bad.request.error", "errors": [ { "requestField": "edgeLocationId", "title": "Conflicting values.", "type": "field.conflict" }, { "requestField": "edgeIp", "title": "Conflicting values.", "type": "field.conflict" } ] }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/400.yaml" } }, "401": { "description": "[Authorization error](https://techdocs.akamai.com/edge-diagnostics/reference/401).", "content": { "application/problem+json": { "example": { "detail": "Inactive client token", "instance": "https://akab-nedrvuylepskzabx-lv3dgceqqktx3i5b.luna.akamaiapis.net/edge-diagnostics/v1/grep/requests", "status": 401, "title": "Not authorized", "type": "https://problems.luna.akamaiapis.net/-/pep-authn/deny" }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/401.yaml" } }, "403": { "description": "[Permission error](https://techdocs.akamai.com/edge-diagnostics/reference/403).", "content": { "application/problem+json": { "example": { "status": 403, "title": "Forbidden request.", "type": "forbidden.request.error", "errors": [ { "detail": "You don't have access to the requested URL. Contact your Admin to request access.", "requestField": "url", "title": "Field access denied.", "type": "field.access.denied" } ] }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/403.yaml" } }, "405": { "description": "[Method not allowed](https://techdocs.akamai.com/edge-diagnostics/reference/405).", "content": { "application/problem+json": { "example": { "title": "Method not allowed", "type": "method.not.allowed" }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/405.yaml" } }, "429": { "description": "[Too many requests](https://techdocs.akamai.com/edge-diagnostics/reference/429).", "content": { "application/problem+json": { "example": { "detail": "You have exceeded total number of requests configured for this API.", "status": 429, "title": "Too Many Requests", "type": "requests.exceeded.error" }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/429.yaml" } } }, "parameters": [ { "description": "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ] } }, "/content-problems/requests/{requestId}": { "get": { "description": "Returns the status of the [asynchronous](https://techdocs.akamai.com/edge-diagnostics/reference/asynchronous-processes) [Run the content problems scenario](https://techdocs.akamai.com/edge-diagnostics/reference/post-content-problems) request. Operations with the `SUCCESS` status include fetched GREP and cURL data.", "operationId": "get-content-problems", "summary": "Get the Content problems scenario response", "tags": [ "Content problems" ], "externalDocs": { "description": "See documentation for this operation in Akamai's Edge Diagnostics API", "url": "https://techdocs.akamai.com/edge-diagnostics/reference/get-content-problems" }, "responses": { "200": { "description": "The response provides the status of the request and its details.", "content": { "application/json": { "example": { "createdBy": "tyamada", "createdTime": "2021-11-26T13:41:07Z", "executionStatus": "SUCCESS", "internalIp": "192.0.2.17", "requestId": 365, "internalIpLocation": { "asNumber": 20940, "city": "ADELAIDE", "countryCode": "AU", "regionCode": "SA" }, "request": { "edgeLocationId": "adelaide-sa-australia", "ipVersion": "IPV4", "spoofEdgeIp": "192.0.2.9", "url": "https://www.example.com", "requestHeaders": [ "Test: Test" ] }, "spoofEdgeIpLocation": { "asNumber": 20940, "city": "MUMBAI", "countryCode": "IN", "regionCode": "MH" }, "summary": { "content": [ { "executionContext": "DEFAULT", "executionStatus": "SUCCESS", "suggestedActions": [ "Compare the response headers served from edge and origin.", "Check for content correctness.", "Check content length/bytes served." ], "additionalRequestParameters": { "includeDefaultPragmaHeaders": true }, "result": { "responseHeaderList": [] } } ], "logLines": [ { "executionContext": "DEFAULT", "executionStatus": "SUCCESS", "suggestedActions": [ "Check content length/bytes served." ], "result": { "legend": { "fObjectStatus": { "D": "A default object was served.", "a": "This response was sent through the ESI processor.", "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." }, "fObjectStatus2": {}, "fObjectStatus3": {}, "logType": { "f": "(f) going forward to forward hostname" }, "rObjectStatus": {}, "rObjectStatus2": {}, "rObjectStatus3": {} }, "logs": [ { "clientIp": "192.0.2.17", "contentBytesServed": "-", "edgeIp": "192.0.2.14", "forwardIp": "192.0.2.18", "logType": "f", "objectStatus": "oaDx", "timeTaken": "0", "turnaroundTime": "3494" } ] } } ] }, "content": [ { "executionContext": "DEFAULT", "executionStatus": "SUCCESS", "suggestedActions": [ "Compare the response headers served from edge and origin.", "Check for content correctness.", "Check content length/bytes served." ], "additionalRequestParameters": { "includeDefaultPragmaHeaders": true }, "result": { "httpStatusCode": 200, "httpVersion": "HTTP/1.1", "reasonPhrase": "OK", "responseHeaderList": [ "Transfer-Encoding: chunked", "X-Cache: TCP_MISS from a23-212-50-38.deploy.akamaitechnologies.com (AkamaiGHost/10.4.6-37171458) (-)", "Content-Type: text/html; charset=UTF-8", "X-Powered-By: PHP/7.3.2" ], "timing": { "dnsLookupTime": 1.509502, "sslConnectionTime": 0, "tcpConnectionTime": 1.524193, "timeToFirstByte": 1.555875, "totalTime": 2.091051 } } } ], "logLines": [ { "executionContext": "DEFAULT", "executionStatus": "SUCCESS", "suggestedActions": [ "Check content length/bytes served." ], "result": { "legend": { "fObjectStatus": { "D": "A default object was served.", "a": "This response was sent through the ESI processor.", "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." }, "fObjectStatus2": {}, "fObjectStatus3": {}, "logType": { "f": "(f) going forward to forward hostname" }, "rObjectStatus": {}, "rObjectStatus2": {}, "rObjectStatus3": {} }, "logs": [ { "arl": "/D/16382/474258/000/origin-www.example.com/%20vcd=1360", "bytesReceived": "21154", "bytesServed": "-", "clientIp": "192.0.2.17", "contentBytesServed": "-", "contentType": "text/html", "cookie": "-", "cpCode": "1234567", "dateTime": "2021-11-26T13:41:18.014Z", "edgeIp": "192.0.2.14", "error": "-", "forwardHostname": "origin-www.example.com", "forwardIp": "192.0.2.18", "hostHeader": "-", "httpMethod": "GET", "httpStatus": "200", "logType": "f", "objectSize": "-", "objectStatus": "oaDx", "objectStatus2": "-", "objectStatus3": "-", "referer": "-", "sslVersion": "TLSv1.2", "timeTaken": "0", "turnaroundTime": "3494", "userAgent": "-" } ] } } ] }, "schema": { "additionalProperties": false, "description": "Collects the Content problems scenario results and details about the request.", "type": "object", "required": [ "summary", "content", "request", "requestId", "executionStatus", "createdBy", "createdTime", "internalIp", "internalIpLocation", "logLines" ], "properties": { "content": { "description": "Lists the results of the cURL request.", "minItems": 1, "type": "array", "items": { "additionalProperties": false, "type": "object", "required": [ "executionContext", "executionStatus" ], "properties": { "additionalRequestParameters": { "additionalProperties": false, "description": "Specifies the cURL request.", "minProperties": 1, "type": "object", "properties": { "includeDefaultPragmaHeaders": { "description": "Indicates whether the request included the default list of `Pragma` headers. Check [Pragma headers](https://techdocs.akamai.com/edge-diagnostics/docs/pragma-headers) to learn about default Akamai Pragma headers.", "type": "boolean" }, "ipVersion": { "description": "IP version used by the request, either `IPV4` or `IPV6`.", "type": "string", "enum": [ "IPV4", "IPV6" ] }, "requestHeaders": { "description": "Customized headers for `curl` request in the format `header: value`.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } } }, "x-akamai": { "file-path": "schemas/additionalCurlRequestParameters.yaml" } }, "errorResponse": { "additionalProperties": false, "description": "Specifies the reason for `FAILURE` status.", "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Details about the error.", "minLength": 1, "type": "string" }, "errors": { "description": "Collects information about problems occurred while fetching the data.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } }, "status": { "description": "Error status code.", "minLength": 1, "type": "string" }, "title": { "description": "Error title.", "minLength": 1, "type": "string" }, "type": { "description": "Error type.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/errorResponse.yaml" } }, "executionContext": { "description": "Execution context. The only possible value is `DEFAULT`. For now, this member doesn't provide any meaningful data.", "type": "string", "enum": [ "DEFAULT" ] }, "executionStatus": { "description": "Status of the cURL request's execution, either `SUCCESS` or `FAILURE`.", "type": "string", "enum": [ "SUCCESS", "FAILURE" ] }, "result": { "additionalProperties": false, "description": "Results of the `curl` command.", "minProperties": 1, "type": "object", "required": [ "exitCode" ], "properties": { "exitCode": { "description": "Curl command exit code. [List of possible curl exit code.](https://curl.se/libcurl/c/libcurl-errors.html) ", "minimum": 0, "type": "integer" }, "httpStatusCode": { "description": "Returned HTTP response code.", "maximum": 599, "minimum": 100, "type": "integer" }, "httpVersion": { "description": "HTTP version used for `curl`.", "minLength": 1, "type": "string" }, "reasonPhrase": { "description": "Reason phrase for the response.", "minLength": 1, "type": "string" }, "responseBody": { "description": "Entire response body.", "minLength": 1, "type": "string" }, "responseHeaderList": { "description": "Collects the response headers in the format `header: value`.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } }, "timing": { "additionalProperties": false, "description": "Collects the time related data.", "type": "object", "required": [ "dnsLookupTime", "tcpConnectionTime", "sslConnectionTime", "timeToFirstByte", "totalTime" ], "properties": { "dnsLookupTime": { "description": "DNS lookup time, in seconds.", "minimum": 0, "type": "number" }, "sslConnectionTime": { "description": "SSL connection time, in seconds.", "minimum": 0, "type": "number" }, "tcpConnectionTime": { "description": "TCP connection time, in seconds.", "minimum": 0, "type": "number" }, "timeToFirstByte": { "description": "Time to first byte, in seconds.", "minimum": 0, "type": "number" }, "totalTime": { "description": "Total time, in seconds.", "minimum": 0, "type": "number" } } } }, "x-akamai": { "file-path": "schemas/curlResults.yaml" } }, "suggestedActions": { "description": "Suggestions on what to do next with the results.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } } }, "x-akamai": { "file-path": "schemas/contentDetail.yaml" } } }, "createdBy": { "description": "Username who submitted the request.", "minLength": 1, "type": "string" }, "createdTime": { "description": "ISO 8601 timestamp indicating when the request was submitted.", "format": "date-time", "type": "string" }, "errorResponse": { "additionalProperties": false, "description": "Specifies the reason for `FAILURE` status.", "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Details about the error.", "minLength": 1, "type": "string" }, "errors": { "description": "Collects information about problems occurred while fetching the data.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } }, "status": { "description": "Error status code.", "minLength": 1, "type": "string" }, "title": { "description": "Error title.", "minLength": 1, "type": "string" }, "type": { "description": "Error type.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/errorResponse.yaml" } }, "executionStatus": { "description": "Status of the request's execution. Possible values are: `SUCCESS`, `FAILURE`, or `IN_PROGRESS`.", "type": "string", "enum": [ "SUCCESS", "FAILURE", "IN_PROGRESS" ] }, "internalIp": { "description": "Machine IP for the requested location used to forward the request to the origin server.", "minLength": 1, "type": "string" }, "internalIpLocation": { "additionalProperties": false, "description": "Specifies the geolocation of `internalIp`.", "type": "object", "required": [ "city", "regionCode", "countryCode", "asNumber" ], "properties": { "asNumber": { "description": "Autonomous System Number the edge IP maps to.", "minimum": 0, "type": "integer" }, "city": { "description": "Closest city within a 50-mile radius the edge IP maps to.", "minLength": 1, "type": "string" }, "countryCode": { "description": "ISO 3166 country code the edge IP maps to.", "minLength": 1, "type": "string" }, "regionCode": { "description": "ISO 3166 region code the edge IP maps to.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/edgeIpLocation.yaml" } }, "link": { "description": "Link to get the Content problems scenario response after the `retryAfter` interval passes. It occurs only for operations with the `IN_PROGRESS` status.", "minLength": 1, "type": "string" }, "logLines": { "description": "Lists the results of the GREP request.", "minItems": 1, "type": "array", "items": { "additionalProperties": false, "description": "Collects fetched logs.", "type": "object", "required": [ "executionContext", "executionStatus" ], "properties": { "errorResponse": { "additionalProperties": false, "description": "Specifies the reason for `FAILURE` status.", "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Details about the error.", "minLength": 1, "type": "string" }, "errors": { "description": "Collects information about problems occurred while fetching the data.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } }, "status": { "description": "Error status code.", "minLength": 1, "type": "string" }, "title": { "description": "Error title.", "minLength": 1, "type": "string" }, "type": { "description": "Error type.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/errorResponse.yaml" } }, "executionContext": { "description": "Execution context. The only possible value is `DEFAULT`. For now, this member doesn't provide any meaningful data.", "type": "string", "enum": [ "DEFAULT" ] }, "executionStatus": { "description": "Status of the GREP request's execution, either `SUCCESS` or `FAILURE`.", "type": "string", "enum": [ "SUCCESS", "FAILURE" ] }, "result": { "additionalProperties": false, "description": "Provides logs fetched with the GREP command.", "type": "object", "required": [ "logs", "legend" ], "properties": { "legend": { "additionalProperties": false, "description": "Descriptions of returned `logType`, `objectStatus`, `objectStatus2`, `objectStatus3` in `r` and `f` log lines.", "type": "object", "required": [ "logType", "rObjectStatus", "rObjectStatus2", "rObjectStatus3", "fObjectStatus", "fObjectStatus2", "fObjectStatus3" ], "properties": { "fObjectStatus": { "description": "Descriptions of the `objectStatus` data in f-line.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } }, "fObjectStatus2": { "description": "Descriptions of the `objectStatus2` data in f-line.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } }, "fObjectStatus3": { "description": "Descriptions of the `objectStatus3` data in f-line.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } }, "logType": { "description": "Description of the `logType` data.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } }, "rObjectStatus": { "description": "Descriptions of the `objectStatus` data in r-line.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } }, "rObjectStatus2": { "description": "Descriptions of the `objectStatus2` data in r-line.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } }, "rObjectStatus3": { "description": "Descriptions of the `objectStatus3` data in r-line.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } } }, "x-akamai": { "file-path": "schemas/legend.yaml" } }, "logs": { "description": "Filtered log lines.", "minItems": 0, "type": "array", "items": { "description": "Items provided as key/value pairs.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } } } }, "x-akamai": { "file-path": "schemas/logsContainer.yaml" } }, "suggestedActions": { "description": "Suggestions on what to do next with the results.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } } }, "x-akamai": { "file-path": "schemas/logLines.yaml" } } }, "request": { "additionalProperties": false, "description": "Specifies your Content problems scenario request.", "type": "object", "required": [ "url" ], "properties": { "edgeLocationId": { "description": "Unique identifier for an edge server location closest to end users experiencing issues with the URL. Run the [List available edge server locations](https://techdocs.akamai.com/edge-diagnostics/reference/get-edge-locations) operation to get this value.", "minLength": 1, "type": "string" }, "ipVersion": { "description": "IP version for the Content problems scenario to use to run cURL and MTR commands, either `IPV4` or `IPV6`.", "type": "string", "enum": [ "IPV4", "IPV6" ] }, "requestHeaders": { "description": "Customized headers for the `curl` request in the format `header: value`. The request includes [Akamai Pragma headers](https://techdocs.akamai.com/edge-diagnostics/docs/pragma-headers) by default.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } }, "runFromSiteShield": { "description": "Runs Content problems from a Site Shield map. To learn more, check [Site Shield requests](https://techdocs.akamai.com/edge-diagnostics/reference/site-shield-requests).", "type": "boolean" }, "sensitiveRequestHeaderKeys": { "description": "Sensitive `requestHeaders` you don't want to store in the database after running the request. Check [Sensitive headers](https://techdocs.akamai.com/edge-diagnostics/reference/sensitive-headers) to see the list of request headers treated as sensitive by default.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } }, "spoofEdgeIp": { "description": "IP of the edge server you want to serve traffic from. You can use the `ip` value from the `edgeIps` array in the [collected diagnostic data](https://techdocs.akamai.com/edge-diagnostics/reference/get-user-diagnostic-data-group-records).", "minLength": 1, "type": "string" }, "url": { "description": "URL you want to run the Content problems scenario for.", "format": "uri", "type": "string" } }, "x-akamai": { "file-path": "schemas/contentProblemsRequest.yaml" } }, "requestId": { "description": "Unique identifier for the Content problems scenario request. Store this value to run the [Get the Content problems scenario response](https://techdocs.akamai.com/edge-diagnostics/reference/get-content-problems) operation.", "minimum": 0, "type": "integer" }, "retryAfter": { "description": "Number of seconds when the request is estimated to have processed. It occurs only for operations with the `IN_PROGRESS` status.", "minimum": 0, "type": "integer" }, "siteShieldIp": { "description": "If your request specifies `runFromSiteShield` as `true`, then this IP is used to run Content problems.", "minLength": 1, "type": "string" }, "siteShieldIpLocation": { "additionalProperties": false, "description": "Specifies the geolocation of the edge server used to run the operation.", "type": "object", "required": [ "city", "regionCode", "countryCode", "asNumber" ], "properties": { "asNumber": { "description": "Autonomous System Number the edge IP maps to.", "minimum": 0, "type": "integer" }, "city": { "description": "Closest city within a 50-mile radius the edge IP maps to.", "minLength": 1, "type": "string" }, "countryCode": { "description": "ISO 3166 country code the edge IP maps to.", "minLength": 1, "type": "string" }, "regionCode": { "description": "ISO 3166 region code the edge IP maps to.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/edgeIpLocation.yaml" } }, "spoofEdgeIpLocation": { "additionalProperties": false, "description": "Specifies the geolocation of the edge server used to serve the request.", "type": "object", "required": [ "city", "regionCode", "countryCode", "asNumber" ], "properties": { "asNumber": { "description": "Autonomous System Number the edge IP maps to.", "minimum": 0, "type": "integer" }, "city": { "description": "Closest city within a 50-mile radius the edge IP maps to.", "minLength": 1, "type": "string" }, "countryCode": { "description": "ISO 3166 country code the edge IP maps to.", "minLength": 1, "type": "string" }, "regionCode": { "description": "ISO 3166 region code the edge IP maps to.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/edgeIpLocation.yaml" } }, "summary": { "additionalProperties": false, "description": "Collects partial results of the Content problems scenario. These results contain fetched data that Edge Diagnostics identified as potential source of issues.", "type": "object", "required": [ "content", "logLines" ], "properties": { "content": { "description": "Lists the results of the cURL request.", "minItems": 0, "type": "array", "items": { "additionalProperties": false, "type": "object", "required": [ "executionContext", "executionStatus" ], "properties": { "additionalRequestParameters": { "additionalProperties": false, "description": "Specifies the cURL request.", "minProperties": 1, "type": "object", "properties": { "includeDefaultPragmaHeaders": { "description": "Indicates whether the request included the default list of `Pragma` headers. Check [Pragma headers](https://techdocs.akamai.com/edge-diagnostics/docs/pragma-headers) to learn about default Akamai Pragma headers.", "type": "boolean" }, "ipVersion": { "description": "IP version used by the request, either `IPV4` or `IPV6`.", "type": "string", "enum": [ "IPV4", "IPV6" ] }, "requestHeaders": { "description": "Customized headers for `curl` request in the format `header: value`.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } } }, "x-akamai": { "file-path": "schemas/additionalCurlRequestParameters.yaml" } }, "errorResponse": { "additionalProperties": false, "description": "Specifies the reason for `FAILURE` status.", "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Details about the error.", "minLength": 1, "type": "string" }, "errors": { "description": "Collects information about problems occurred while fetching the data.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } }, "status": { "description": "Error status code.", "minLength": 1, "type": "string" }, "title": { "description": "Error title.", "minLength": 1, "type": "string" }, "type": { "description": "Error type.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/errorResponse.yaml" } }, "executionContext": { "description": "Execution context. The only possible value is `DEFAULT`. For now, this member doesn't provide any meaningful data.", "type": "string", "enum": [ "DEFAULT" ] }, "executionStatus": { "description": "Status of the cURL request's execution, either `SUCCESS` or `FAILURE`.", "type": "string", "enum": [ "SUCCESS", "FAILURE" ] }, "result": { "additionalProperties": false, "description": "Results of the `curl` command.", "minProperties": 1, "type": "object", "required": [ "exitCode" ], "properties": { "exitCode": { "description": "Curl command exit code. [List of possible curl exit code.](https://curl.se/libcurl/c/libcurl-errors.html) ", "minimum": 0, "type": "integer" }, "httpStatusCode": { "description": "Returned HTTP response code.", "maximum": 599, "minimum": 100, "type": "integer" }, "httpVersion": { "description": "HTTP version used for `curl`.", "minLength": 1, "type": "string" }, "reasonPhrase": { "description": "Reason phrase for the response.", "minLength": 1, "type": "string" }, "responseBody": { "description": "Entire response body.", "minLength": 1, "type": "string" }, "responseHeaderList": { "description": "Collects the response headers in the format `header: value`.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } }, "timing": { "additionalProperties": false, "description": "Collects the time related data.", "type": "object", "required": [ "dnsLookupTime", "tcpConnectionTime", "sslConnectionTime", "timeToFirstByte", "totalTime" ], "properties": { "dnsLookupTime": { "description": "DNS lookup time, in seconds.", "minimum": 0, "type": "number" }, "sslConnectionTime": { "description": "SSL connection time, in seconds.", "minimum": 0, "type": "number" }, "tcpConnectionTime": { "description": "TCP connection time, in seconds.", "minimum": 0, "type": "number" }, "timeToFirstByte": { "description": "Time to first byte, in seconds.", "minimum": 0, "type": "number" }, "totalTime": { "description": "Total time, in seconds.", "minimum": 0, "type": "number" } } } }, "x-akamai": { "file-path": "schemas/curlResults.yaml" } }, "suggestedActions": { "description": "Suggestions on what to do next with the results.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } } }, "x-akamai": { "file-path": "schemas/contentDetail.yaml" } } }, "logLines": { "description": "Lists the results of the GREP request.", "minItems": 0, "type": "array", "items": { "additionalProperties": false, "description": "Collects fetched logs.", "type": "object", "required": [ "executionContext", "executionStatus" ], "properties": { "errorResponse": { "additionalProperties": false, "description": "Specifies the reason for `FAILURE` status.", "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Details about the error.", "minLength": 1, "type": "string" }, "errors": { "description": "Collects information about problems occurred while fetching the data.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } }, "status": { "description": "Error status code.", "minLength": 1, "type": "string" }, "title": { "description": "Error title.", "minLength": 1, "type": "string" }, "type": { "description": "Error type.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/errorResponse.yaml" } }, "executionContext": { "description": "Execution context. The only possible value is `DEFAULT`. For now, this member doesn't provide any meaningful data.", "type": "string", "enum": [ "DEFAULT" ] }, "executionStatus": { "description": "Status of the GREP request's execution, either `SUCCESS` or `FAILURE`.", "type": "string", "enum": [ "SUCCESS", "FAILURE" ] }, "result": { "additionalProperties": false, "description": "Provides logs fetched with the GREP command.", "type": "object", "required": [ "logs", "legend" ], "properties": { "legend": { "additionalProperties": false, "description": "Descriptions of returned `logType`, `objectStatus`, `objectStatus2`, `objectStatus3` in `r` and `f` log lines.", "type": "object", "required": [ "logType", "rObjectStatus", "rObjectStatus2", "rObjectStatus3", "fObjectStatus", "fObjectStatus2", "fObjectStatus3" ], "properties": { "fObjectStatus": { "description": "Descriptions of the `objectStatus` data in f-line.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } }, "fObjectStatus2": { "description": "Descriptions of the `objectStatus2` data in f-line.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } }, "fObjectStatus3": { "description": "Descriptions of the `objectStatus3` data in f-line.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } }, "logType": { "description": "Description of the `logType` data.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } }, "rObjectStatus": { "description": "Descriptions of the `objectStatus` data in r-line.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } }, "rObjectStatus2": { "description": "Descriptions of the `objectStatus2` data in r-line.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } }, "rObjectStatus3": { "description": "Descriptions of the `objectStatus3` data in r-line.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } } }, "x-akamai": { "file-path": "schemas/legend.yaml" } }, "logs": { "description": "Filtered log lines.", "minItems": 0, "type": "array", "items": { "description": "Items provided as key/value pairs.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } } } }, "x-akamai": { "file-path": "schemas/logsContainer.yaml" } }, "suggestedActions": { "description": "Suggestions on what to do next with the results.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } } }, "x-akamai": { "file-path": "schemas/logLines.yaml" } } } }, "x-akamai": { "file-path": "schemas/contentProblemsSummary.yaml" } } }, "x-akamai": { "file-path": "schemas/contentProblemsResponse.yaml" } } } }, "headers": { "X-RateLimit-Limit": { "description": "The rate limit ceiling for this endpoint.", "example": 10, "schema": { "type": "integer" }, "x-akamai": { "file-path": "headers/X-RateLimit-Limit.yaml" } }, "X-RateLimit-Remaining": { "description": "The number of requests left for the time window.", "example": 5, "schema": { "type": "integer" }, "x-akamai": { "file-path": "headers/X-RateLimit-Remaining.yaml" } } } }, "401": { "description": "[Authorization error](https://techdocs.akamai.com/edge-diagnostics/reference/401).", "content": { "application/problem+json": { "example": { "detail": "Inactive client token", "instance": "https://akab-nedrvuylepskzabx-lv3dgceqqktx3i5b.luna.akamaiapis.net/edge-diagnostics/v1/grep/requests", "status": 401, "title": "Not authorized", "type": "https://problems.luna.akamaiapis.net/-/pep-authn/deny" }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/401.yaml" } }, "403": { "description": "[Permission error](https://techdocs.akamai.com/edge-diagnostics/reference/403).", "content": { "application/problem+json": { "example": { "status": 403, "title": "Forbidden request.", "type": "forbidden.request.error", "errors": [ { "detail": "You don't have access to the requested URL. Contact your Admin to request access.", "requestField": "url", "title": "Field access denied.", "type": "field.access.denied" } ] }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/403.yaml" } }, "404": { "description": "[Resource not found error](https://techdocs.akamai.com/edge-diagnostics/reference/404).", "content": { "application/problem+json": { "example": { "detail": "The requested resource couldn't be found. Make sure that the resource is not deleted and the ID is correct.", "status": 404, "title": "Resource not found.", "type": "resource.not.found" }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/404.yaml" } }, "405": { "description": "[Method not allowed](https://techdocs.akamai.com/edge-diagnostics/reference/405).", "content": { "application/problem+json": { "example": { "title": "Method not allowed", "type": "method.not.allowed" }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/405.yaml" } }, "429": { "description": "[Too many requests](https://techdocs.akamai.com/edge-diagnostics/reference/429).", "content": { "application/problem+json": { "example": { "detail": "You have exceeded total number of requests configured for this API.", "status": 429, "title": "Too Many Requests", "type": "requests.exceeded.error" }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/429.yaml" } } }, "parameters": [ { "description": "Includes response bodies in the response.", "example": "{{includeContentResponseBody}}", "in": "query", "name": "includeContentResponseBody", "schema": { "example": false, "type": "boolean" }, "x-akamai": { "file-path": "parameters/includeContentResponseBody-query.yaml" } }, { "description": "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ] }, "parameters": [ { "description": "Unique identifier for a request. To get this value, run the corresponding POST operation.", "example": "{{requestId}}", "in": "path", "name": "requestId", "required": true, "schema": { "example": 365, "type": "integer" }, "x-akamai": { "file-path": "parameters/requestId-path.yaml" } } ] }, "/curl": { "post": { "description": "Requests content using the `curl` command to provide the raw HTML for a URL, including request headers. You can run this operation for a specific location, an edge server IP, or a Site Shield map. If you want to get the data for a location, you need to run the [List available edge server locations](https://techdocs.akamai.com/edge-diagnostics/reference/get-edge-locations) operation first to get `edgeLocationId`. And if you want to run this operation for an IP, you may need to [verify an IP](https://techdocs.akamai.com/edge-diagnostics/reference/post-verify-edge-ip) to check if it belongs to an edge server. If you provide neither a location nor an edge server IP, then Edge Diagnostics runs the operation using a random edge server IP.", "operationId": "post-curl", "summary": "Request content with cURL", "tags": [ "CURL" ], "externalDocs": { "description": "See documentation for this operation in Akamai's Edge Diagnostics API", "url": "https://techdocs.akamai.com/edge-diagnostics/reference/post-curl" }, "requestBody": { "required": true, "content": { "application/json": { "example": { "edgeIp": "192.0.2.12", "ipVersion": "IPV4", "url": "https://www.example.com", "requestHeaders": [ "Connection: keep-alive", "Accept-Language: en-US" ] }, "schema": { "additionalProperties": false, "description": "Collects data to use in the `curl` request.", "type": "object", "required": [ "url" ], "properties": { "edgeIp": { "description": "IP of the edge server you want to run the operation from. If you don't know if an IP is the edge IP, run the [Verify an IP](https://techdocs.akamai.com/edge-diagnostics/reference/post-verify-edge-ip) operation. You need to provide either this value or `edgeLocationId`.", "example": "{{edgeIp}}", "minLength": 1, "type": "string" }, "edgeLocationId": { "description": "Unique identifier for an edge server location closest to your end users. To get this value, run the [List available edge server locations](https://techdocs.akamai.com/edge-diagnostics/reference/get-edge-locations) operation first. You need to provide either this value or `edgeIp`.", "example": "{{edgeLocationId}}", "minLength": 1, "type": "string" }, "ipVersion": { "description": "IP version to use to run the operation, either `IPV4` or `IPV6`.", "example": "{{ipVersion}}", "type": "string", "enum": [ "IPV4", "IPV6" ] }, "requestHeaders": { "description": "Customized headers for `curl` request in the format `header: value`. Check [Pragma headers](https://techdocs.akamai.com/edge-diagnostics/docs/pragma-headers) for the list of Akamaized Pragma headers you can use here.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } }, "runFromSiteShield": { "description": "Runs `curl` from a Site Shield map. To learn more, check [Site Shield requests](https://techdocs.akamai.com/edge-diagnostics/reference/site-shield-requests).", "example": "{{runFromSiteShield}}", "type": "boolean" }, "sensitiveRequestHeaderKeys": { "description": "Sensitive `requestHeaders` you don't want to store in the database after running the request. Check [Sensitive headers](https://techdocs.akamai.com/edge-diagnostics/reference/sensitive-headers) to see the list of request headers treated as sensitive by default.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } }, "spoofEdgeIp": { "description": "IP of the edge server you want to serve traffic from.", "example": "{{spoofEdgeIp}}", "minLength": 1, "type": "string" }, "url": { "description": "URL you want to get the raw HTML for.", "example": "{{url}}", "format": "uri", "type": "string" } }, "x-akamai": { "file-path": "schemas/curlRequest.yaml" } } } } }, "responses": { "200": { "description": "The response provides the `curl` results and details about the request.", "content": { "application/json": { "example": { "completedTime": "2021-04-20T08:50:36+0000", "createdBy": "adevi", "createdTime": "2021-04-20T08:50:34+0000", "executionStatus": "SUCCESS", "internalIp": "192.0.2.12", "edgeIpLocation": { "asNumber": 123, "city": "TOKYO", "countryCode": "JP", "regionCode": "13" }, "request": { "edgeIp": "192.0.2.12", "ipVersion": "IPV4", "url": "https://www.example.com", "requestHeaders": [ "Connection: keep-alive", "Accept-Language: en-US" ] }, "result": { "exitCode": 0, "httpStatusCode": 200, "httpVersion": "HTTP/1.1", "reasonPhrase": "OK", "responseHeaderList": [ "X-Cache: HIT", "Cache-Control: max-age=604800", "Etag: \"3147526947+ident\"", "Age: 314154", "Date: Tue, 20 Apr 2021 08:50:35 GMT", "Content-Type: text/html; charset=UTF-8" ], "timing": { "dnsLookupTime": 1.509502, "sslConnectionTime": 0, "tcpConnectionTime": 1.524193, "timeToFirstByte": 1.555875, "totalTime": 2.091051 } } }, "schema": { "additionalProperties": false, "description": "Collects the `curl` response and details about the request.", "type": "object", "required": [ "createdBy", "createdTime", "completedTime", "executionStatus", "internalIp", "edgeIpLocation", "request" ], "properties": { "completedTime": { "description": "ISO 8601 timestamp indicating when the request was completed.", "format": "date-time", "type": "string" }, "createdBy": { "description": "Username who submitted the request.", "minLength": 1, "type": "string" }, "createdTime": { "description": "ISO 8601 timestamp indicating when the request was submitted.", "format": "date-time", "type": "string" }, "edgeIpLocation": { "additionalProperties": false, "description": "Specifies the geolocation of the edge server used to run the operation.", "type": "object", "required": [ "city", "regionCode", "countryCode", "asNumber" ], "properties": { "asNumber": { "description": "Autonomous System Number the edge IP maps to.", "minimum": 0, "type": "integer" }, "city": { "description": "Closest city within a 50-mile radius the edge IP maps to.", "minLength": 1, "type": "string" }, "countryCode": { "description": "ISO 3166 country code the edge IP maps to.", "minLength": 1, "type": "string" }, "regionCode": { "description": "ISO 3166 region code the edge IP maps to.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/edgeIpLocation.yaml" } }, "executionStatus": { "description": "Status of the request's execution, either `SUCCESS` or `FAILURE`.", "type": "string", "enum": [ "SUCCESS", "FAILURE" ] }, "internalIp": { "description": "If your request contained `edgeLocationId` then this is the IP of a machine in that location. If you run the operation for a VIP, then this is the IP of a machine behind that VIP.", "minLength": 1, "type": "string" }, "request": { "additionalProperties": false, "description": "Specifies your `curl` request.", "type": "object", "required": [ "url" ], "properties": { "edgeIp": { "description": "IP of the edge server you want to run the operation from. If you don't know if an IP is the edge IP, run the [Verify an IP](https://techdocs.akamai.com/edge-diagnostics/reference/post-verify-edge-ip) operation. You need to provide either this value or `edgeLocationId`.", "minLength": 1, "type": "string" }, "edgeLocationId": { "description": "Unique identifier for an edge server location closest to your end users. To get this value, run the [List available edge server locations](https://techdocs.akamai.com/edge-diagnostics/reference/get-edge-locations) operation first. You need to provide either this value or `edgeIp`.", "minLength": 1, "type": "string" }, "ipVersion": { "description": "IP version to use to run the operation, either `IPV4` or `IPV6`.", "type": "string", "enum": [ "IPV4", "IPV6" ] }, "requestHeaders": { "description": "Customized headers for `curl` request in the format `header: value`. Check [Pragma headers](https://techdocs.akamai.com/edge-diagnostics/docs/pragma-headers) for the list of Akamaized Pragma headers you can use here.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } }, "runFromSiteShield": { "description": "Runs `curl` from a Site Shield map. To learn more, check [Site Shield requests](https://techdocs.akamai.com/edge-diagnostics/reference/site-shield-requests).", "type": "boolean" }, "sensitiveRequestHeaderKeys": { "description": "Sensitive `requestHeaders` you don't want to store in the database after running the request. Check [Sensitive headers](https://techdocs.akamai.com/edge-diagnostics/reference/sensitive-headers) to see the list of request headers treated as sensitive by default.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } }, "spoofEdgeIp": { "description": "IP of the edge server you want to serve traffic from.", "minLength": 1, "type": "string" }, "url": { "description": "URL you want to get the raw HTML for.", "format": "uri", "type": "string" } }, "x-akamai": { "file-path": "schemas/curlRequest.yaml" } }, "result": { "additionalProperties": false, "description": "Results of the `curl` command.", "minProperties": 1, "type": "object", "required": [ "exitCode" ], "properties": { "exitCode": { "description": "Curl command exit code. [List of possible curl exit code.](https://curl.se/libcurl/c/libcurl-errors.html) ", "minimum": 0, "type": "integer" }, "httpStatusCode": { "description": "Returned HTTP response code.", "maximum": 599, "minimum": 100, "type": "integer" }, "httpVersion": { "description": "HTTP version used for `curl`.", "minLength": 1, "type": "string" }, "reasonPhrase": { "description": "Reason phrase for the response.", "minLength": 1, "type": "string" }, "responseBody": { "description": "Entire response body.", "minLength": 1, "type": "string" }, "responseHeaderList": { "description": "Collects the response headers in the format `header: value`.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } }, "timing": { "additionalProperties": false, "description": "Collects the time related data.", "type": "object", "required": [ "dnsLookupTime", "tcpConnectionTime", "sslConnectionTime", "timeToFirstByte", "totalTime" ], "properties": { "dnsLookupTime": { "description": "DNS lookup time, in seconds.", "minimum": 0, "type": "number" }, "sslConnectionTime": { "description": "SSL connection time, in seconds.", "minimum": 0, "type": "number" }, "tcpConnectionTime": { "description": "TCP connection time, in seconds.", "minimum": 0, "type": "number" }, "timeToFirstByte": { "description": "Time to first byte, in seconds.", "minimum": 0, "type": "number" }, "totalTime": { "description": "Total time, in seconds.", "minimum": 0, "type": "number" } } } }, "x-akamai": { "file-path": "schemas/curlResults.yaml" } }, "siteShieldIp": { "description": "If your request specifies `runFromSiteShield` as `true`, then this is the IP used to run cURL.", "minLength": 1, "type": "string" }, "siteShieldIpLocation": { "additionalProperties": false, "description": "Specifies the geolocation of the edge server used to run the operation. It appears only for `runFromSiteShield` set to `true`.", "type": "object", "required": [ "city", "regionCode", "countryCode", "asNumber" ], "properties": { "asNumber": { "description": "Autonomous System Number the edge IP maps to.", "minimum": 0, "type": "integer" }, "city": { "description": "Closest city within a 50-mile radius the edge IP maps to.", "minLength": 1, "type": "string" }, "countryCode": { "description": "ISO 3166 country code the edge IP maps to.", "minLength": 1, "type": "string" }, "regionCode": { "description": "ISO 3166 region code the edge IP maps to.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/edgeIpLocation.yaml" } }, "suggestedActions": { "description": "Suggestions on what to do next with the results.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } } }, "x-akamai": { "file-path": "schemas/curlResponse.yaml" } } } }, "headers": { "X-RateLimit-Limit": { "description": "The rate limit ceiling for this endpoint.", "example": 10, "schema": { "type": "integer" }, "x-akamai": { "file-path": "headers/X-RateLimit-Limit.yaml" } }, "X-RateLimit-Remaining": { "description": "The number of requests left for the time window.", "example": 5, "schema": { "type": "integer" }, "x-akamai": { "file-path": "headers/X-RateLimit-Remaining.yaml" } } } }, "400": { "description": "[Validation error](https://techdocs.akamai.com/edge-diagnostics/reference/400).", "content": { "application/problem+json": { "example": { "detail": "Provide only one of these members, either `edgeLocationId` or `edgeIp`.", "status": 400, "title": "Incorrect request.", "type": "bad.request.error", "errors": [ { "requestField": "edgeLocationId", "title": "Conflicting values.", "type": "field.conflict" }, { "requestField": "edgeIp", "title": "Conflicting values.", "type": "field.conflict" } ] }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/400.yaml" } }, "401": { "description": "[Authorization error](https://techdocs.akamai.com/edge-diagnostics/reference/401).", "content": { "application/problem+json": { "example": { "detail": "Inactive client token", "instance": "https://akab-nedrvuylepskzabx-lv3dgceqqktx3i5b.luna.akamaiapis.net/edge-diagnostics/v1/grep/requests", "status": 401, "title": "Not authorized", "type": "https://problems.luna.akamaiapis.net/-/pep-authn/deny" }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/401.yaml" } }, "403": { "description": "[Permission error](https://techdocs.akamai.com/edge-diagnostics/reference/403).", "content": { "application/problem+json": { "example": { "status": 403, "title": "Forbidden request.", "type": "forbidden.request.error", "errors": [ { "detail": "You don't have access to the requested URL. Contact your Admin to request access.", "requestField": "url", "title": "Field access denied.", "type": "field.access.denied" } ] }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/403.yaml" } }, "405": { "description": "[Method not allowed](https://techdocs.akamai.com/edge-diagnostics/reference/405).", "content": { "application/problem+json": { "example": { "title": "Method not allowed", "type": "method.not.allowed" }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/405.yaml" } }, "429": { "description": "[Too many requests](https://techdocs.akamai.com/edge-diagnostics/reference/429).", "content": { "application/problem+json": { "example": { "detail": "You have exceeded total number of requests configured for this API.", "status": 429, "title": "Too Many Requests", "type": "requests.exceeded.error" }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/429.yaml" } } }, "parameters": [ { "description": "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ] } }, "/dig": { "post": { "description": "Uses the `dig` command to provide DNS details for the location of an edge server, a hostname or a domain name, or a GTM hostname. The results may help you diagnose issues with domain name resolutions. You can run this operation either for a specific location or an edge IP. If you want to get the data for a location, you need to run the [List available edge server locations](https://techdocs.akamai.com/edge-diagnostics/reference/get-edge-locations) operation first to get `edgeLocationId`. To run this operation for an IP, you may need to [verify an IP](https://techdocs.akamai.com/edge-diagnostics/reference/post-verify-edge-ip), if it belongs to an edge server. And to run this operation for a GTM hostname, you need to run the [List GTM properties](https://techdocs.akamai.com/edge-diagnostics/reference/get-gtm-properties) operation first. If you don't provide neither a location ID nor an edge server IP, then Edge Diagnostics runs the operation using a random edge server IP.", "operationId": "post-dig", "summary": "Get domain details with dig", "tags": [ "Dig" ], "externalDocs": { "description": "See documentation for this operation in Akamai's Edge Diagnostics API", "url": "https://techdocs.akamai.com/edge-diagnostics/reference/post-dig" }, "requestBody": { "required": true, "content": { "application/json": { "example": { "edgeLocationId": "tokyo-13-japan", "hostname": "www.example.com", "isGtmHostname": true, "queryType": "A" }, "schema": { "additionalProperties": false, "description": "Collects data to use in the `dig` request.", "type": "object", "required": [ "hostname", "queryType", "isGtmHostname" ], "properties": { "edgeIp": { "description": "IP of an edge server you want to run the `dig` command from. Provide either this value or `edgeLocationId`. To verify if an IP belongs to an edge server, run the [Verify an IP](https://techdocs.akamai.com/edge-diagnostics/reference/post-verify-edge-ip) operation.", "example": "{{edgeIp}}", "minLength": 1, "type": "string" }, "edgeLocationId": { "description": "Unique identifier for an edge server location closest to your end users. Provide either this value or `edgeIp`. To get this value, run the [List available edge server locations](https://techdocs.akamai.com/edge-diagnostics/reference/get-edge-locations) operation first.", "example": "{{edgeLocationId}}", "minLength": 1, "type": "string" }, "hostname": { "description": "Hostname or a domain name you want to get the data for. For a GTM hostname, run the [List GTM properties](https://techdocs.akamai.com/edge-diagnostics/reference/get-gtm-properties) operation first, to get this value.", "example": "{{hostname}}", "format": "hostname", "type": "string" }, "isGtmHostname": { "description": "Specifies `hostname` is a GTM hostname.", "example": "{{isGtmHostname}}", "type": "boolean" }, "queryType": { "description": "DNS record type you want to get. Possible values are: `A`, `AAAA`, `SOA`, `CNAME`, `PTR`, `MX`, `NS`, `TXT`, `SRV`, `CAA`, and `ANY`. To learn more about them, check [Supported DNS record types](https://techdocs.akamai.com/edge-diagnostics/docs/domain-details-dig#supported-dns-record-types).", "example": "{{queryType}}", "type": "string", "enum": [ "A", "AAAA", "SOA", "CNAME", "PTR", "MX", "NS", "TXT", "SRV", "CAA", "ANY" ] } }, "x-akamai": { "file-path": "schemas/digPostRequest.yaml" } } } } }, "responses": { "200": { "description": "The response provides the `dig` results and details about the request.", "content": { "application/json": { "example": { "completedTime": "2020-12-24T04:25:42Z", "createdBy": "adevi", "createdTime": "2020-12-24T04:25:40Z", "executionStatus": "SUCCESS", "internalIp": "192.0.2.16", "edgeIpLocation": { "asNumber": 20940, "city": "TOKYO", "countryCode": "JP", "regionCode": "13" }, "result": { "answerSection": [ { "hostname": "www.example.com.", "preferenceValue": null, "recordClass": "IN", "recordType": "CNAME", "ttl": 3600, "value": "www.example.com." }, { "hostname": "www.example.com.", "preferenceValue": null, "recordClass": "IN", "recordType": "A", "ttl": 600, "value": "192.0.2.221" } ], "authoritySection": [ { "domain": "example.com.", "preferenceValue": null, "recordClass": "IN", "recordType": "NS", "ttl": 86399, "value": "a.example.net." }, { "domain": "example.com.", "preferenceValue": null, "recordClass": "IN", "recordType": "NS", "ttl": 86399, "value": "b.example.net." } ] } }, "schema": { "additionalProperties": false, "description": "Collects the `dig` response and details about the request.", "type": "object", "required": [ "request", "createdBy", "createdTime", "completedTime", "executionStatus", "edgeIpLocation" ], "properties": { "completedTime": { "description": "ISO 8601 timestamp indicating when the request was completed.", "format": "date-time", "type": "string" }, "createdBy": { "description": "Username who submitted the request.", "minLength": 1, "type": "string" }, "createdTime": { "description": "ISO 8601 timestamp indicating when the request was submitted.", "format": "date-time", "type": "string" }, "edgeIpLocation": { "additionalProperties": false, "description": "Specifies the geolocation of the edge server used to serve the requested `hostname`.", "type": "object", "required": [ "city", "regionCode", "countryCode", "asNumber" ], "properties": { "asNumber": { "description": "Autonomous System Number the edge IP maps to.", "minimum": 0, "type": "integer" }, "city": { "description": "Closest city within a 50-mile radius the edge IP maps to.", "minLength": 1, "type": "string" }, "countryCode": { "description": "ISO 3166 country code the edge IP maps to.", "minLength": 1, "type": "string" }, "regionCode": { "description": "ISO 3166 region code the edge IP maps to.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/edgeIpLocation.yaml" } }, "executionStatus": { "description": "Status of the request's execution, either `SUCCESS` or `FAILURE`.", "type": "string", "enum": [ "SUCCESS", "FAILURE" ] }, "internalIp": { "description": "If your request contained `edgeLocationId`, then this is the IP of a machine in that location. If you run the operation for a VIP, then this is the IP of a machine behind that VIP.", "minLength": 1, "type": "string" }, "request": { "additionalProperties": false, "description": "Specifies your `dig` request.", "type": "object", "required": [ "hostname", "queryType", "isGtmHostname" ], "properties": { "edgeIp": { "description": "IP of an edge server you want to run the `dig` command from. Provide either this value or `edgeLocationId`. To verify if an IP belongs to an edge server, run the [Verify an IP](https://techdocs.akamai.com/edge-diagnostics/reference/post-verify-edge-ip) operation.", "minLength": 1, "type": "string" }, "edgeLocationId": { "description": "Unique identifier for an edge server location closest to your end users. Provide either this value or `edgeIp`. To get this value, run the [List available edge server locations](https://techdocs.akamai.com/edge-diagnostics/reference/get-edge-locations) operation first.", "minLength": 1, "type": "string" }, "hostname": { "description": "Hostname or a domain name you want to get the data for. For a GTM hostname, run the [List GTM properties](https://techdocs.akamai.com/edge-diagnostics/reference/get-gtm-properties) operation first, to get this value.", "format": "hostname", "type": "string" }, "isGtmHostname": { "description": "Specifies `hostname` is a GTM hostname.", "type": "boolean" }, "queryType": { "description": "DNS record type you want to get. Possible values are: `A`, `AAAA`, `SOA`, `CNAME`, `PTR`, `MX`, `NS`, `TXT`, `SRV`, `CAA`, and `ANY`. To learn more about them, check [Supported DNS record types](https://techdocs.akamai.com/edge-diagnostics/docs/domain-details-dig#supported-dns-record-types).", "type": "string", "enum": [ "A", "AAAA", "SOA", "CNAME", "PTR", "MX", "NS", "TXT", "SRV", "CAA", "ANY" ] } }, "x-akamai": { "file-path": "schemas/digPostRequest.yaml" } }, "result": { "additionalProperties": false, "description": "Standard `dig` response.", "type": "object", "required": [ "result" ], "properties": { "answerSection": { "description": "Collects a DNS record of answering servers.", "minItems": 1, "type": "array", "items": { "additionalProperties": false, "description": "Specifies a DNS record that appears within a response of the [Get domain details with dig](https://techdocs.akamai.com/edge-diagnostics/reference/post-dig) operation, in `answerSection` or `authoritySection`.", "type": "object", "properties": { "domain": { "description": "Domain name for this record.", "minLength": 1, "type": "string" }, "hostname": { "description": "Hostname you requested the data for.", "format": "hostname", "type": "string" }, "preferenceValue": { "description": "Preference value, only valid for records of the `MX` type, otherwise `null`.", "minimum": 0, "nullable": true, "type": "integer" }, "recordClass": { "description": "Class of the record, typically `IN` for *internet*.", "minLength": 1, "type": "string" }, "recordType": { "description": "Requested record type. Possible values are: `A`, `AAAA`, `SOA`, `CNAME`, `PTR`, `MX`, `NS`, `TXT`, `SRV`, `CAA`, and `ANY`. To learn more about them, check [Supported DNS record types](https://techdocs.akamai.com/edge-diagnostics/docs/domain-details-dig#supported-dns-record-types).", "type": "string", "enum": [ "A", "AAAA", "SOA", "CNAME", "PTR", "MX", "NS", "TXT", "SRV", "CAA", "ANY" ] }, "ttl": { "description": "Server's default number of seconds to keep content cached.", "minimum": 0, "type": "integer" }, "value": { "description": "Record's value, either another domain or a final IP address.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/dnsRecord.yaml" }, "oneOf": [ { "title": "Hostname required", "required": [ "hostname", "ttl", "recordClass", "recordType", "value" ] }, { "title": "Domain required", "required": [ "domain", "ttl", "recordClass", "recordType", "value" ] } ] } }, "authoritySection": { "description": "Collects a DNS record of servers authorized to answer.", "minItems": 1, "type": "array", "items": { "additionalProperties": false, "description": "Specifies a DNS record that appears within a response of the [Get domain details with dig](https://techdocs.akamai.com/edge-diagnostics/reference/post-dig) operation, in `answerSection` or `authoritySection`.", "type": "object", "properties": { "domain": { "description": "Domain name for this record.", "minLength": 1, "type": "string" }, "hostname": { "description": "Hostname you requested the data for.", "format": "hostname", "type": "string" }, "preferenceValue": { "description": "Preference value, only valid for records of the `MX` type, otherwise `null`.", "minimum": 0, "nullable": true, "type": "integer" }, "recordClass": { "description": "Class of the record, typically `IN` for *internet*.", "minLength": 1, "type": "string" }, "recordType": { "description": "Requested record type. Possible values are: `A`, `AAAA`, `SOA`, `CNAME`, `PTR`, `MX`, `NS`, `TXT`, `SRV`, `CAA`, and `ANY`. To learn more about them, check [Supported DNS record types](https://techdocs.akamai.com/edge-diagnostics/docs/domain-details-dig#supported-dns-record-types).", "type": "string", "enum": [ "A", "AAAA", "SOA", "CNAME", "PTR", "MX", "NS", "TXT", "SRV", "CAA", "ANY" ] }, "ttl": { "description": "Server's default number of seconds to keep content cached.", "minimum": 0, "type": "integer" }, "value": { "description": "Record's value, either another domain or a final IP address.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/dnsRecord.yaml" }, "oneOf": [ { "title": "Hostname required", "required": [ "hostname", "ttl", "recordClass", "recordType", "value" ] }, { "title": "Domain required", "required": [ "domain", "ttl", "recordClass", "recordType", "value" ] } ] } }, "result": { "description": "Raw `dig` output.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/digInfo.yaml" } } }, "x-akamai": { "file-path": "schemas/digPostResponse.yaml" } } } }, "headers": { "X-RateLimit-Limit": { "description": "The rate limit ceiling for this endpoint.", "example": 10, "schema": { "type": "integer" }, "x-akamai": { "file-path": "headers/X-RateLimit-Limit.yaml" } }, "X-RateLimit-Remaining": { "description": "The number of requests left for the time window.", "example": 5, "schema": { "type": "integer" }, "x-akamai": { "file-path": "headers/X-RateLimit-Remaining.yaml" } } } }, "400": { "description": "[Validation error](https://techdocs.akamai.com/edge-diagnostics/reference/400).", "content": { "application/problem+json": { "example": { "detail": "Provide only one of these members, either `edgeLocationId` or `edgeIp`.", "status": 400, "title": "Incorrect request.", "type": "bad.request.error", "errors": [ { "requestField": "edgeLocationId", "title": "Conflicting values.", "type": "field.conflict" }, { "requestField": "edgeIp", "title": "Conflicting values.", "type": "field.conflict" } ] }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/400.yaml" } }, "401": { "description": "[Authorization error](https://techdocs.akamai.com/edge-diagnostics/reference/401).", "content": { "application/problem+json": { "example": { "detail": "Inactive client token", "instance": "https://akab-nedrvuylepskzabx-lv3dgceqqktx3i5b.luna.akamaiapis.net/edge-diagnostics/v1/grep/requests", "status": 401, "title": "Not authorized", "type": "https://problems.luna.akamaiapis.net/-/pep-authn/deny" }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/401.yaml" } }, "403": { "description": "[Permission error](https://techdocs.akamai.com/edge-diagnostics/reference/403).", "content": { "application/problem+json": { "example": { "status": 403, "title": "Forbidden request.", "type": "forbidden.request.error", "errors": [ { "detail": "You don't have access to the requested URL. Contact your Admin to request access.", "requestField": "url", "title": "Field access denied.", "type": "field.access.denied" } ] }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/403.yaml" } }, "405": { "description": "[Method not allowed](https://techdocs.akamai.com/edge-diagnostics/reference/405).", "content": { "application/problem+json": { "example": { "title": "Method not allowed", "type": "method.not.allowed" }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/405.yaml" } }, "429": { "description": "[Too many requests](https://techdocs.akamai.com/edge-diagnostics/reference/429).", "content": { "application/problem+json": { "example": { "detail": "You have exceeded total number of requests configured for this API.", "status": 429, "title": "Too Many Requests", "type": "requests.exceeded.error" }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/429.yaml" } } }, "parameters": [ { "description": "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ] } }, "/edge-locations": { "get": { "description": "Lists active edge server locations you can use to run [Request content with cURL](https://techdocs.akamai.com/edge-diagnostics/reference/post-curl), [Get domain details with dig](https://techdocs.akamai.com/edge-diagnostics/reference/post-dig), [Test network connectivity with MTR](https://techdocs.akamai.com/edge-diagnostics/reference/post-mtr), [Run the URL health check](https://techdocs.akamai.com/edge-diagnostics/reference/post-url-health-check), [Run the connectivity problems scenario](https://techdocs.akamai.com/edge-diagnostics/reference/post-connectivity-problems), and [Run the content problems scenario](https://techdocs.akamai.com/edge-diagnostics/reference/post-content-problems) operations. To get a subset of edge servers supporting metadata tracer, run the [List available edge server locations for metadata tracing](https://techdocs.akamai.com/edge-diagnostics/reference/get-mdt-locations) operation.", "operationId": "get-edge-locations", "summary": "List available edge server locations", "tags": [ "Edge server locations" ], "externalDocs": { "description": "See documentation for this operation in Akamai's Edge Diagnostics API", "url": "https://techdocs.akamai.com/edge-diagnostics/reference/get-edge-locations" }, "responses": { "200": { "description": "The response lists available edge server locations.", "content": { "application/json": { "example": { "edgeLocations": [ { "id": "buenosaires-argentina", "value": "Buenosaires, Argentina" }, { "id": "seattle-wa-unitedstates", "value": "Seattle, WA, United States" } ] }, "schema": { "additionalProperties": false, "description": "Collects locations of active edge servers you can run [Request content with cURL](https://techdocs.akamai.com/edge-diagnostics/reference/post-curl), [Get domain details with dig](https://techdocs.akamai.com/edge-diagnostics/reference/post-dig), [Test network connectivity with MTR](https://techdocs.akamai.com/edge-diagnostics/reference/post-mtr), [Run the URL health check](https://techdocs.akamai.com/edge-diagnostics/reference/post-url-health-check) and [Run the connectivity problems scenario](https://techdocs.akamai.com/edge-diagnostics/reference/post-connectivity-problems) operations with within a top-level `edgeLocations` array.", "type": "object", "required": [ "edgeLocations" ], "properties": { "edgeLocations": { "description": "Lists identifiers and names of available locations.", "minItems": 1, "type": "array", "items": { "additionalProperties": false, "type": "object", "required": [ "id", "value" ], "properties": { "id": { "description": "Unique identifier for the location. Use this value for an `edgeLocationId` member in subsequent operations.", "minLength": 1, "type": "string" }, "value": { "description": "Name of the location.", "minLength": 1, "type": "string" } } } } }, "x-akamai": { "file-path": "schemas/edgeLocations.yaml" } } } }, "headers": { "X-RateLimit-Limit": { "description": "The rate limit ceiling for this endpoint.", "example": 10, "schema": { "type": "integer" }, "x-akamai": { "file-path": "headers/X-RateLimit-Limit.yaml" } }, "X-RateLimit-Remaining": { "description": "The number of requests left for the time window.", "example": 5, "schema": { "type": "integer" }, "x-akamai": { "file-path": "headers/X-RateLimit-Remaining.yaml" } } } }, "401": { "description": "[Authorization error](https://techdocs.akamai.com/edge-diagnostics/reference/401).", "content": { "application/problem+json": { "example": { "detail": "Inactive client token", "instance": "https://akab-nedrvuylepskzabx-lv3dgceqqktx3i5b.luna.akamaiapis.net/edge-diagnostics/v1/grep/requests", "status": 401, "title": "Not authorized", "type": "https://problems.luna.akamaiapis.net/-/pep-authn/deny" }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/401.yaml" } }, "403": { "description": "[Permission error](https://techdocs.akamai.com/edge-diagnostics/reference/403).", "content": { "application/problem+json": { "example": { "status": 403, "title": "Forbidden request.", "type": "forbidden.request.error", "errors": [ { "detail": "You don't have access to the requested URL. Contact your Admin to request access.", "requestField": "url", "title": "Field access denied.", "type": "field.access.denied" } ] }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/403.yaml" } }, "405": { "description": "[Method not allowed](https://techdocs.akamai.com/edge-diagnostics/reference/405).", "content": { "application/problem+json": { "example": { "title": "Method not allowed", "type": "method.not.allowed" }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/405.yaml" } }, "429": { "description": "[Too many requests](https://techdocs.akamai.com/edge-diagnostics/reference/429).", "content": { "application/problem+json": { "example": { "detail": "You have exceeded total number of requests configured for this API.", "status": 429, "title": "Too Many Requests", "type": "requests.exceeded.error" }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/429.yaml" } } }, "parameters": [ { "description": "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ] } }, "/error-translator": { "post": { "description": "Launches an [asynchronous](https://techdocs.akamai.com/edge-diagnostics/reference/asynchronous-processes) request to fetch summary and logs for an error with a specific reference code. You can also translate any Global Request Number (GRN) generated by the Property Manager's Global Request Number behavior. You can get the error logs from the last 6 or 24 hours depending on the server and traffic conditions. For operations in progress, the returned object contains `retryAfter`, `requestId`, and `link`. In this case, wait for the duration of the `retryAfter` interval, then either use the `requestId` to run the [Get a translate error string response](https://techdocs.akamai.com/edge-diagnostics/reference/get-error-translator-request) operation, or simply GET the `link`.", "operationId": "post-error-translator", "summary": "Translate error string", "tags": [ "Error translator" ], "externalDocs": { "description": "See documentation for this operation in Akamai's Edge Diagnostics API", "url": "https://techdocs.akamai.com/edge-diagnostics/reference/post-error-translator" }, "requestBody": { "required": true, "content": { "application/json": { "example": { "errorCode": "1.5e3b5b68.1621415935.409841", "traceForwardLogs": true }, "schema": { "additionalProperties": false, "description": "Specifies the error reference code of the request.", "type": "object", "required": [ "errorCode" ], "properties": { "errorCode": { "description": "Alphanumeric part of the error reference code you want to get the data for.", "example": "{{errorCode}}", "minLength": 1, "type": "string" }, "traceForwardLogs": { "description": "Gets logs from all edge servers involved in serving the request. When `false`, you get logs only from the edge server where the error occurred. Tracing forward logs may prolong the time of fetching data. The default value is `false`.", "example": "{{traceForwardLogs}}", "type": "boolean" } }, "x-akamai": { "file-path": "schemas/errorTranslatorRequest.yaml" } } } } }, "responses": { "202": { "description": "Process successfully launched.", "content": { "application/json": { "example": { "completedTime": "2021-05-19T09:28:38Z", "createdBy": "alfulani", "createdTime": "2021-05-19T09:28:24Z", "executionStatus": "SUCCESS", "requestId": 345, "suggestedActions": [ "Check for long times.", "Check content length/bytes served." ], "request": { "errorCode": "1.5e3b5b68.1621415935.409841", "traceForwardLogs": true }, "result": { "cacheKeyHostname": "example.com.", "clientRequestMethod": "GET", "cpCode": 1234567, "date": "2021-05-19T09:28:24+0000", "epochTime": 1621415934, "grepUrl": "/edge-diagnostics/v1/grep?edgeIp=192.0.2.9&cpCode=1234567&httpStatusCode=504&userAgent=Mozilla/5.0%20(Macintosh;%20Intel%20Mac%20OS%20X%2010_15_7)%20AppleWebKit/537.36%20(KHTML,%20like%20Gecko)%20Chrome/90.0.4430.212%20Safari/537.36&start=2021-05-19T09:23:24&end=2021-05-19T09:33:24Z&clientIp=192.0.2.9&arl=/D/1682/1234567/000/example.com./ERR_READ_TIMEOUT", "httpResponseCode": 504, "propertyName": "esi-examples.akamai.com_pm", "propertyUrl": "/apps/property-manager/#/property?gid=18385&aid=164879", "reasonForFailure": "The forward connection to the origin server from the edge server timed out.", "url": "https://etranslator.edgesuite.net/ERR_READ_TIMEOUT", "userAgent": "Mozilla/5.0%20(Macintosh;%20Intel%20Mac%20OS%20X%2010_15_7)%20AppleWebKit/537.36%20(KHTML,%20like%20Gecko)%20Chrome/90.0.4430.212%20Safari/537.36", "wafDetails": "-", "wafDetailsUrl": "/apps/security-config/#/next/configs/29531/versions/239/policies/RHBM_81115", "wsaUrl": "/apps/securitycenter/#/web-security-analytics?cid=58847&startTime=1647510549925&endTime=1647511149925&dim=%5B%22trans.url%22%5D&filters=%5B%5B%22in%22%2C%22trans.ipXff%22%2C%5B%22192.0.2.9%22%5D%2Ctrue%5D%2C%5B%22in%22%2C%22trans.ip%22%2C%5B%22192.0.2.8%22%5D%2Ctrue%5D%2C%5B%22in%22%2C%22trans.statusCode%22%2C%5B%22100%22%5D%2Ctrue%5D%2C%5B%22in%22%2C%22trans.policyId%22%2C%5B%22waf%22%5D%2Ctrue%5D%5D", "clientIp": { "ip": "192.0.2.9", "ipLocation": { "asNumber": 9583, "city": "BANGALORE", "countryCode": "IN", "regionCode": "KA" } }, "connectingIp": { "ip": "192.0.2.9", "ipLocation": { "asNumber": 9583, "city": "BANGALORE", "countryCode": "IN", "regionCode": "KA" } }, "edgeServerIp": { "ip": "192.0.2.9", "ipLocation": { "asNumber": 9583, "city": "BANGALORE", "countryCode": "IN", "regionCode": "KA" } }, "logLines": { "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": "-" } ] }, "originIp": { "ip": "192.0.2.9", "ipLocation": { "asNumber": 9583, "city": "BANGALORE", "countryCode": "IN", "regionCode": "KA" } } } }, "schema": { "additionalProperties": false, "description": "Specifies the error with the specific reference code and about the request. For operations in progress, the returned object contains `retryAfter`, `requestId`, and `link`. In this case, wait for the duration of the `retryAfter` interval, then either use the `requestId` to run the [Get a translate error string response](https://techdocs.akamai.com/edge-diagnostics/reference/get-error-translator-request) operation, or simply GET the `link`.", "type": "object", "required": [ "createdBy", "createdTime", "completedTime", "executionStatus", "request" ], "properties": { "completedTime": { "description": "ISO 8601 timestamp indicating when the request was completed.", "format": "date-time", "type": "string" }, "createdBy": { "description": "Username who submitted the request.", "minLength": 1, "type": "string" }, "createdTime": { "description": "ISO 8601 timestamp indicating when the request was submitted.", "format": "date-time", "type": "string" }, "executionStatus": { "description": "Status of the request's execution. Possible values are `SUCCESS`, `FAILURE`, or `IN_PROGRESS`.", "type": "string", "enum": [ "SUCCESS", "FAILURE", "IN_PROGRESS" ] }, "link": { "description": "Link to GET the error translator response after the `retryAfter` interval passes. It occurs only for operations with the `IN_PROGRESS` status.", "minLength": 1, "type": "string" }, "request": { "additionalProperties": false, "description": "Specifies your request.", "type": "object", "required": [ "errorCode" ], "properties": { "errorCode": { "description": "Alphanumeric part of the error reference code you want to get the data for.", "minLength": 1, "type": "string" }, "traceForwardLogs": { "description": "Gets logs from all edge servers involved in serving the request. When `false`, you get logs only from the edge server where the error occurred. Tracing forward logs may prolong the time of fetching data. The default value is `false`.", "type": "boolean" } }, "x-akamai": { "file-path": "schemas/errorTranslatorRequest.yaml" } }, "requestId": { "description": "Unique identifier for the error translator request. Store this value to run [Get a translate error string response](https://techdocs.akamai.com/edge-diagnostics/reference/get-error-translator-request) operation.", "minimum": 0, "type": "integer" }, "result": { "additionalProperties": false, "description": "Specifies the error. It occurs only for operations with the `SUCCESS` status. ", "type": "object", "properties": { "cacheKeyHostname": { "description": "Cache key hostname.", "format": "hostname", "type": "string" }, "certificateErrorDetails": { "additionalProperties": false, "description": "Specifies a certificate error for 30.x.x.x error codes.", "type": "object", "required": [ "error", "solution" ], "properties": { "error": { "description": "Error details.", "type": "string" }, "fingerPrint": { "description": "Certificate fingerprint you can share with a support team to compare with the origin certificate.", "type": "string" }, "solution": { "description": "Suggested solution.", "type": "string" } }, "x-akamai": { "file-path": "schemas/certificateErrorDetails.yaml" } }, "clientIp": { "additionalProperties": false, "description": "Specifies the client that attempted to contact the edge server to request the content.", "type": "object", "required": [ "ip", "ipLocation" ], "properties": { "ip": { "description": "IP address.", "minLength": 1, "type": "string" }, "ipLocation": { "additionalProperties": false, "description": "Specifies IP's geolocation.", "type": "object", "required": [ "city", "regionCode", "countryCode", "asNumber" ], "properties": { "asNumber": { "description": "Autonomous System Number the edge IP maps to.", "minimum": 0, "type": "integer" }, "city": { "description": "Closest city within a 50-mile radius the edge IP maps to.", "minLength": 1, "type": "string" }, "countryCode": { "description": "ISO 3166 country code the edge IP maps to.", "minLength": 1, "type": "string" }, "regionCode": { "description": "ISO 3166 region code the edge IP maps to.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/edgeIpLocation.yaml" } } }, "x-akamai": { "file-path": "schemas/ipDetails.yaml" } }, "clientRequestMethod": { "description": "The HTTP method that the client requested for the URL.", "minLength": 1, "type": "string" }, "connectingIp": { "additionalProperties": false, "description": "Specifies the connecting server.", "type": "object", "required": [ "ip", "ipLocation" ], "properties": { "ip": { "description": "IP address.", "minLength": 1, "type": "string" }, "ipLocation": { "additionalProperties": false, "description": "Specifies IP's geolocation.", "type": "object", "required": [ "city", "regionCode", "countryCode", "asNumber" ], "properties": { "asNumber": { "description": "Autonomous System Number the edge IP maps to.", "minimum": 0, "type": "integer" }, "city": { "description": "Closest city within a 50-mile radius the edge IP maps to.", "minLength": 1, "type": "string" }, "countryCode": { "description": "ISO 3166 country code the edge IP maps to.", "minLength": 1, "type": "string" }, "regionCode": { "description": "ISO 3166 region code the edge IP maps to.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/edgeIpLocation.yaml" } } }, "x-akamai": { "file-path": "schemas/ipDetails.yaml" } }, "cpCode": { "description": "CP code for this request.", "minimum": 0, "type": "integer" }, "date": { "description": "ISO 8601 timestamp indicating when the request took place.", "format": "date-time", "type": "string" }, "edgeServerIp": { "additionalProperties": false, "description": "Specifies the edge server that answered the client's request or served the error.", "type": "object", "required": [ "ip", "ipLocation" ], "properties": { "ip": { "description": "IP address.", "minLength": 1, "type": "string" }, "ipLocation": { "additionalProperties": false, "description": "Specifies IP's geolocation.", "type": "object", "required": [ "city", "regionCode", "countryCode", "asNumber" ], "properties": { "asNumber": { "description": "Autonomous System Number the edge IP maps to.", "minimum": 0, "type": "integer" }, "city": { "description": "Closest city within a 50-mile radius the edge IP maps to.", "minLength": 1, "type": "string" }, "countryCode": { "description": "ISO 3166 country code the edge IP maps to.", "minLength": 1, "type": "string" }, "regionCode": { "description": "ISO 3166 region code the edge IP maps to.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/edgeIpLocation.yaml" } } }, "x-akamai": { "file-path": "schemas/ipDetails.yaml" } }, "epochTime": { "description": "When the request occurred, in epoch seconds.", "minimum": 0, "type": "integer" }, "grepUrl": { "description": "Link you can use to get log lines for specified criteria.", "minLength": 1, "type": "string" }, "httpResponseCode": { "description": "HTTP response code for this request.", "minimum": 0, "type": "integer" }, "logLines": { "additionalProperties": false, "description": "Collects log lines for this error request.", "type": "object", "required": [ "logs", "legend" ], "properties": { "legend": { "additionalProperties": false, "description": "Descriptions of returned `logType`, `objectStatus`, `objectStatus2`, `objectStatus3` in `r` and `f` log lines.", "type": "object", "required": [ "logType", "rObjectStatus", "rObjectStatus2", "rObjectStatus3", "fObjectStatus", "fObjectStatus2", "fObjectStatus3" ], "properties": { "fObjectStatus": { "description": "Descriptions of the `objectStatus` data in f-line.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } }, "fObjectStatus2": { "description": "Descriptions of the `objectStatus2` data in f-line.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } }, "fObjectStatus3": { "description": "Descriptions of the `objectStatus3` data in f-line.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } }, "logType": { "description": "Description of the `logType` data.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } }, "rObjectStatus": { "description": "Descriptions of the `objectStatus` data in r-line.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } }, "rObjectStatus2": { "description": "Descriptions of the `objectStatus2` data in r-line.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } }, "rObjectStatus3": { "description": "Descriptions of the `objectStatus3` data in r-line.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } } }, "x-akamai": { "file-path": "schemas/legend.yaml" } }, "logs": { "description": "Filtered log lines.", "minItems": 0, "type": "array", "items": { "description": "Items provided as key/value pairs.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } } } }, "x-akamai": { "file-path": "schemas/logsContainer.yaml" } }, "noLogsErrorTitle": { "description": "If logs not fetched, details of the error.", "minLength": 1, "type": "string" }, "noLogsErrorType": { "description": "If logs not fetched, type of the error.", "minLength": 1, "type": "string" }, "originIp": { "additionalProperties": false, "description": "Specifies origin server that the edge server attempted to connect to.", "type": "object", "required": [ "ip", "ipLocation" ], "properties": { "ip": { "description": "IP address.", "minLength": 1, "type": "string" }, "ipLocation": { "additionalProperties": false, "description": "Specifies IP's geolocation.", "type": "object", "required": [ "city", "regionCode", "countryCode", "asNumber" ], "properties": { "asNumber": { "description": "Autonomous System Number the edge IP maps to.", "minimum": 0, "type": "integer" }, "city": { "description": "Closest city within a 50-mile radius the edge IP maps to.", "minLength": 1, "type": "string" }, "countryCode": { "description": "ISO 3166 country code the edge IP maps to.", "minLength": 1, "type": "string" }, "regionCode": { "description": "ISO 3166 region code the edge IP maps to.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/edgeIpLocation.yaml" } } }, "x-akamai": { "file-path": "schemas/ipDetails.yaml" } }, "propertyName": { "description": "Property Manager property name applied to serve the request.", "minLength": 1, "type": "string" }, "propertyUrl": { "description": "URL assigned to the `propertyName` in Property Manager.", "minLength": 1, "type": "string" }, "reasonForFailure": { "description": "Error code returned by an edge server that explains why this transaction failed.", "minLength": 1, "type": "string" }, "url": { "description": "URL a client tried to access when the error occurred.", "minLength": 1, "type": "string" }, "userAgent": { "description": "The `User-Agent` HTTP header sent by the client to the edge server.", "minLength": 1, "type": "string" }, "wafDetails": { "description": "Details about the firewall applied to the request.", "minLength": 1, "type": "string" }, "wafDetailsUrl": { "description": "Link to Web Application Firewall (WAF) details.", "minLength": 1, "type": "string" }, "wsaUrl": { "description": "Link to Web Security Analytics (WSA) details.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/translatedError.yaml" } }, "retryAfter": { "description": "Number of seconds when the request is estimated to have processed. It occurs only for operations with the `IN_PROGRESS` status.", "minimum": 0, "type": "integer" }, "suggestedActions": { "description": "Suggestions on what to do next with the results.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } } }, "x-akamai": { "file-path": "schemas/errorTranslatorResponse.yaml" } } } }, "headers": { "X-RateLimit-Limit": { "description": "The rate limit ceiling for this endpoint.", "example": 10, "schema": { "type": "integer" }, "x-akamai": { "file-path": "headers/X-RateLimit-Limit.yaml" } }, "X-RateLimit-Remaining": { "description": "The number of requests left for the time window.", "example": 5, "schema": { "type": "integer" }, "x-akamai": { "file-path": "headers/X-RateLimit-Remaining.yaml" } } } }, "400": { "description": "[Validation error](https://techdocs.akamai.com/edge-diagnostics/reference/400).", "content": { "application/problem+json": { "example": { "detail": "Provide only one of these members, either `edgeLocationId` or `edgeIp`.", "status": 400, "title": "Incorrect request.", "type": "bad.request.error", "errors": [ { "requestField": "edgeLocationId", "title": "Conflicting values.", "type": "field.conflict" }, { "requestField": "edgeIp", "title": "Conflicting values.", "type": "field.conflict" } ] }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/400.yaml" } }, "401": { "description": "[Authorization error](https://techdocs.akamai.com/edge-diagnostics/reference/401).", "content": { "application/problem+json": { "example": { "detail": "Inactive client token", "instance": "https://akab-nedrvuylepskzabx-lv3dgceqqktx3i5b.luna.akamaiapis.net/edge-diagnostics/v1/grep/requests", "status": 401, "title": "Not authorized", "type": "https://problems.luna.akamaiapis.net/-/pep-authn/deny" }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/401.yaml" } }, "403": { "description": "[Permission error](https://techdocs.akamai.com/edge-diagnostics/reference/403).", "content": { "application/problem+json": { "example": { "status": 403, "title": "Forbidden request.", "type": "forbidden.request.error", "errors": [ { "detail": "You don't have access to the requested URL. Contact your Admin to request access.", "requestField": "url", "title": "Field access denied.", "type": "field.access.denied" } ] }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/403.yaml" } }, "405": { "description": "[Method not allowed](https://techdocs.akamai.com/edge-diagnostics/reference/405).", "content": { "application/problem+json": { "example": { "title": "Method not allowed", "type": "method.not.allowed" }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/405.yaml" } }, "429": { "description": "[Too many requests](https://techdocs.akamai.com/edge-diagnostics/reference/429).", "content": { "application/problem+json": { "example": { "detail": "You have exceeded total number of requests configured for this API.", "status": 429, "title": "Too Many Requests", "type": "requests.exceeded.error" }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/429.yaml" } } }, "parameters": [ { "description": "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ] } }, "/error-translator/requests/{requestId}": { "get": { "description": "Returns the status of the [asynchronous](https://techdocs.akamai.com/edge-diagnostics/reference/asynchronous-processes) [Translate error string](https://techdocs.akamai.com/edge-diagnostics/reference/post-error-translator) request. For operations with the `SUCCESS` status, the response includes details about the error. For operations in progress, the returned object contains `retryAfter`, `requestId`, and `link`. In this case, wait for the duration of the `retryAfter` interval, then run this operation again or simply GET the `link`.", "operationId": "get-error-translator-request", "summary": "Get a translate error string response", "tags": [ "Error translator" ], "externalDocs": { "description": "See documentation for this operation in Akamai's Edge Diagnostics API", "url": "https://techdocs.akamai.com/edge-diagnostics/reference/get-error-translator-request" }, "responses": { "200": { "description": "The response provides the status of the request and its details.", "content": { "application/json": { "examples": { "logs-not-fetched": { "summary": "Logs not fetched", "value": { "completedTime": "2021-05-19T09:28:38+0000", "createdBy": "jperez", "createdTime": "2021-05-19T09:28:24+0000", "executionStatus": "SUCCESS", "requestId": 345, "request": { "errorCode": "1.5e3b5b68.1621415935.409841", "traceForwardLogs": true }, "result": { "noLogsErrorTitle": "Failed to get logs. Try again later.", "noLogsErrorType": "not.found.logs.retry" } } }, "with-cert-error": { "summary": "With 30.x.x.x error codes", "value": { "completedTime": "2023-04-11T10:24:53Z", "createdBy": "mrossi", "createdTime": "2023-04-11T10:24:35Z", "executionStatus": "SUCCESS", "requestId": 4284, "suggestedActions": [ "Check for long times.", "Check content length/bytes served." ], "request": { "errorCode": "30.1da83017.1681192994.44c437", "traceForwardLogs": true }, "result": { "cacheKeyHostname": "har-mock-server-dev.npe.hotstar-labs.com", "clientRequestMethod": "GET", "cpCode": 1234567, "date": "2023-04-11T06:03:13+0000", "epochTime": 1681192993, "grepUrl": "/edge-diagnostics/v1/grep?edgeIp=23.48.168.29&cpCode=1234567&start=2023-04-11T05:58:14Z&end=2023-04-11T06:08:14Z&httpStatusCode=503&userAgent=Mozilla/5.0%20(Macintosh;%20Intel%20Mac%20OS%20X%2010_15_7)%20AppleWebKit/537.36%20(KHTML,%20like%20Gecko)%20Chrome/111.0.0.0%20Safari/537.36&clientIp=49.43.100.131&arl=/%3D/267/830457/365d/har-mock-server-dev.npe.hotstar-labs.com/hls/live/2098444/inallow-test-2023/eng/1910021677/15mindvrm0120fa856a84a949659db6b3626dd64b5a28march2023/master_1_01601.ts", "httpResponseCode": 503, "reasonForFailure": "ERR_FWD_SSL_HANDSHAKE|err_conn_strict_cert", "url": "https://livep-pp-ssai-akt-mock-ssai.hotstar.com/hls/live/2098444/inallow-test-2023/eng/1910021677/15mindvrm0120fa856a84a949659db6b3626dd64b5a28march2023/master_1_01601.ts", "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/111.0.0.0 Safari/537.36", "wafDetails": "-", "certificateErrorDetails": { "error": "The CN and SAN hostnames on your origin certificate do not match any of the listed trusted hostnames within your Property Manager configuration.", "fingerPrint": "7b:62:ab:d4:32:fb:d8:97:04:07:9a:ab:8e:be:e6:48:ae:5c:8d:37", "solution": "Review the \"Match CN/SAN To\" field in the Origin Behavior of your Property Manager configuration. By default this matches on either your origin hostname or property host header. If your origin certificate does not contain one of these hostnames you will need to add the certificate CN hostname to this field." }, "clientIp": { "ip": "192.0.2.119", "ipLocation": { "asNumber": 55836, "city": "MUMBAI", "countryCode": "IN", "regionCode": "MH" } }, "connectingIp": { "ip": "192.0.2.178", "ipLocation": { "asNumber": 20940, "city": "SINGAPORE", "countryCode": "SG" } }, "edgeServerIp": { "ip": "192.0.2.254", "ipLocation": { "asNumber": 20940, "city": "KUALALUMPUR", "countryCode": "MY", "regionCode": "14" } }, "logLines": { "legend": { "fObjectStatus": { "P": "Forward request was made to satisfy a cached child.", "o": "Whether the request was to the origin server." }, "fObjectStatus2": { "J": "The request has Site Shield policy on its path to origin even if the Site Shield hop was not reached." }, "fobjectStatus": { "P": "Forward request was made to satisfy a cached child.", "o": "Whether the request was to the origin server." }, "fobjectStatus2": { "J": "The request has Site Shield policy on its path to origin even if the Site Shield hop was not reached." }, "logType": { "f": "(f) going forward to forward hostname", "r": "(r) response to client" }, "rObjectStatus": { "H": "A 'fail-action' or 'fail-action2' was executed or and an edge server served the 'reply-arl' for Request Queuing, in at least the 'fail-action2' serve-alternate - and probably serve-stale - case. This appears on the 'r' line of the 'fail-action' request, not the request that triggered the 'fail-action'.", "J": "The request has Site Shield policy on its path to origin, even if the Site Shield hop was not reached.", "V": "The object TTL was set in metadata.", "o": "The origin server had been contacted." }, "rObjectStatus2": {}, "rObjectStatus3": { "s": "SNI is enabled." }, "robjectStatus": { "H": "A 'fail-action' or 'fail-action2' was executed or and an edge server served the 'reply-arl' for Request Queuing, in at least the 'fail-action2' serve-alternate - and probably serve-stale - case. This appears on the 'r' line of the 'fail-action' request, not the request that triggered the 'fail-action'.", "J": "The request has Site Shield policy on its path to origin, even if the Site Shield hop was not reached.", "V": "The object TTL was set in metadata.", "o": "The origin server had been contacted." }, "robjectStatus2": {}, "robjectStatus3": { "s": "SNI is enabled." } }, "logs": [ { "arl": "/=/267/830457/365d/har-mock-server-dev.npe.hotstar-labs.com/hls/live/2098444/inallow-test-2023/eng/1910021677/15mindvrm0120fa856a84a949659db6b3626dd64b5a28march2023/master_1_01601.ts", "bytesReceived": "-", "bytesServed": "0", "clientIp": "192.0.2.223", "contentBytesServed": "0", "contentType": "text/html", "cookie": "hdntl=exp=1681279192%7eacl=%252f*%7eid=be24dc870c97b05fae8804aefb46577e%7edata=ip%253dLmh1V75u2aFlSartBiFGWU-userid%253dKa2gRbBQ1UwlEUloXjv6LCVuLtnViHlec3Yzq21BqRz9-did%253dqc0EaURWcLrgiDEL3r3hARMJMF2d571gMkA3rKkihdxOzArM6BcFuA7-cc%253din-%7ehmac=5289645e540a57ac04620afc7a3e0ad80d11bfb4ca00b76b7290189799ac0fc5", "cpCode": "1234567", "customField": "country=IN;state=MH;city=MUMBAI;asnum=55836;turnaroundTime=880;transferTime=1;reqEndTime=1;hdntl=exp=1681279192%7eacl=%252f*%7eid=be24dc870c97b05fae8804aefb46577e%7edata=ip%253dLmh1V75u2aFlSartBiFGWU-userid%253dKa2gRbBQ1UwlEUloXjv6LCVuLtnViHlec3Yzq21BqRz9-did%253dqc0EaURWcLrgiDEL3r3hARMJMF2d571gMkA3rKkihdxOzArM6BcFuA7-cc%253din-%7ehmac=5289645e540a57ac04620afc7a3e0ad80d11bfb4ca00b76b7290189799ac0fc5;hdntlsetcookie=;origin=;hdntlRespHeader=;hdntlReqHeader=;SSID=;Via=1.1%20v1-akamaitech.net(ghost)%20(AkamaiGHost);expires=Tue,%2011%20Apr%202023%2006:03:14%20GMT;HS_ID=", "dateTime": "2023-04-11T06:03:13.316Z", "edgeIp": "192.0.2.37", "error": "ERR_FWD_SSL_HANDSHAKE|err_conn_strict_cert", "forwardErrors": "-", "forwardHostname": "-", "forwardIp": "-", "hostHeader": "livep-pp-ssai-akt-mock-ssai.hotstar.com", "httpMethod": "GET", "httpStatus": "503", "logType": "r", "objectSize": "174", "objectStatus": "oJV", "objectStatus2": "-", "objectStatus3": "s", "referer": "https://pp.hotstar.com/", "sslVersion": "TLSv1.3", "timeTaken": "1", "turnaroundTime": "880", "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/111.0.0.0 Safari/537.36" }, { "arl": "/=/267/830457/365d/har-mock-server-dev.npe.hotstar-labs.com/hls/live/2098444/inallow-test-2023/eng/1910021677/15mindvrm0120fa856a84a949659db6b3626dd64b5a28march2023/master_1_01601.ts?failaction=os", "bytesReceived": "-", "bytesServed": "446", "clientIp": "192.0.2.88", "contentBytesServed": "174", "contentType": "text/html", "cookie": "hdntl=exp=1681279192%7eacl=%252f*%7eid=be24dc870c97b05fae8804aefb46577e%7edata=ip%253dLmh1V75u2aFlSartBiFGWU-userid%253dKa2gRbBQ1UwlEUloXjv6LCVuLtnViHlec3Yzq21BqRz9-did%253dqc0EaURWcLrgiDEL3r3hARMJMF2d571gMkA3rKkihdxOzArM6BcFuA7-cc%253din-%7ehmac=5289645e540a57ac04620afc7a3e0ad80d11bfb4ca00b76b7290189799ac0fc5", "cpCode": "1234567", "customField": "OS-failover", "dateTime": "2023-04-11T06:03:14.198Z", "edgeIp": "192.0.2.76", "error": "ERR_FWD_SSL_HANDSHAKE|err_conn_strict_cert", "forwardErrors": "-", "forwardHostname": "-", "forwardIp": "-", "hostHeader": "livep-pp-ssai-akt-mock-ssai.hotstar.com", "httpMethod": "GET", "httpStatus": "503", "logType": "r", "objectSize": "174", "objectStatus": "oJHV", "objectStatus2": "-", "objectStatus3": "s", "referer": "https://pp.hotstar.com/", "sslVersion": "TLSv1.3", "timeTaken": "0", "turnaroundTime": "343", "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/111.0.0.0 Safari/537.36" }, { "arl": "/=/267/830457/365d/har-mock-server-dev.npe.hotstar-labs.com/hls/live/2098444/inallow-test-2023/eng/1910021677/15mindvrm0120fa856a84a949659db6b3626dd64b5a28march2023/master_1_01601.ts", "bytesReceived": "0", "bytesServed": "-", "clientIp": "192.0.2.255", "contentBytesServed": "-", "contentType": "-", "cookie": "-", "cpCode": "1234567", "customField": "-", "dateTime": "2023-04-11T06:03:13.317Z", "edgeIp": "192.0.2.246", "error": "-", "forwardErrors": "ERR_FWD_SSL_HANDSHAKE|err_conn_strict_cert:ssl1416f086:1:0:ECDHE-ECDSA-AES128-GCM-SHA256:128:128", "forwardHostname": "a267.novi-lc-segment.os.pri.lw2.akamaicache.net", "forwardIp": "192.0.2.111", "hostHeader": "-", "httpMethod": "GET", "httpStatus": "0", "logType": "f", "objectSize": "-", "objectStatus": "oP", "objectStatus2": "J", "objectStatus3": "-", "referer": "-", "sslVersion": "TLSv1.2", "timeTaken": "165", "turnaroundTime": "0", "userAgent": "-" }, { "arl": "/=/267/830457/365d/har-mock-server-dev.npe.hotstar-labs.com/hls/live/2098444/inallow-test-2023/eng/1910021677/15mindvrm0120fa856a84a949659db6b3626dd64b5a28march2023/master_1_01601.ts?failaction=os", "bytesReceived": "0", "bytesServed": "-", "clientIp": "192.0.2.1", "contentBytesServed": "-", "contentType": "-", "cookie": "-", "cpCode": "1234567", "customField": "-", "dateTime": "2023-04-11T06:03:14.199Z", "edgeIp": "192.0.2.102", "error": "-", "forwardErrors": "ERR_FWD_SSL_HANDSHAKE|err_conn_strict_cert:ssl1416f086:1:0:ECDHE-ECDSA-AES128-GCM-SHA256:128:128", "forwardHostname": "a267.novi-lc-segment.os.bak.lw2.akamaicache.net", "forwardIp": "192.0.2.30", "hostHeader": "-", "httpMethod": "GET", "httpStatus": "0", "logType": "f", "objectSize": "-", "objectStatus": "oP", "objectStatus2": "J", "objectStatus3": "-", "referer": "-", "sslVersion": "TLSv1.2", "timeTaken": "165", "turnaroundTime": "0", "userAgent": "-" } ] }, "originIp": { "ip": "192.0.2.250", "ipLocation": { "asNumber": 20940, "city": "KUALALUMPUR", "countryCode": "MY", "regionCode": "14" } } } } }, "without-cert-error": { "summary": "Without 30.x.x.x error codes", "value": { "completedTime": "2021-05-19T09:28:38Z", "createdBy": "adevi", "createdTime": "2021-05-19T09:28:24Z", "executionStatus": "SUCCESS", "requestId": 345, "suggestedActions": [ "Check for long times.", "Check content length/bytes served." ], "request": { "errorCode": "1.5e3b5b68.1621415935.409841", "traceForwardLogs": true }, "result": { "cacheKeyHostname": "example.com.", "clientRequestMethod": "GET", "cpCode": 1234567, "date": "2021-05-19T09:28:24+0000", "epochTime": 1621415934, "grepUrl": "/edge-diagnostics/v1/grep?edgeIp=192.0.2.9&cpCode=1234567&httpStatusCode=504&userAgent=Mozilla/5.0%20(Macintosh;%20Intel%20Mac%20OS%20X%2010_15_7)%20AppleWebKit/537.36%20(KHTML,%20like%20Gecko)%20Chrome/90.0.4430.212%20Safari/537.36&start=2021-05-19T09:23:24&end=2021-05-19T09:33:24Z&clientIp=192.0.2.9&arl=/D/1682/1234567/000/example.com./ERR_READ_TIMEOUT", "httpResponseCode": 504, "propertyName": "esi-examples.akamai.com_pm", "propertyUrl": "/apps/property-manager/#/property?gid=18385&aid=164879", "reasonForFailure": "The forward connection to the origin server from the edge server timed out.", "url": "https://etranslator.edgesuite.net/ERR_READ_TIMEOUT", "userAgent": "Mozilla/5.0%20(Macintosh;%20Intel%20Mac%20OS%20X%2010_15_7)%20AppleWebKit/537.36%20(KHTML,%20like%20Gecko)%20Chrome/90.0.4430.212%20Safari/537.36", "wafDetails": "-", "wafDetailsUrl": "/apps/security-config/#/next/configs/29531/versions/239/policies/RHBM_81115", "wsaUrl": "/apps/securitycenter/#/web-security-analytics?cid=58847&startTime=1647510549925&endTime=1647511149925&dim=%5B%22trans.url%22%5D&filters=%5B%5B%22in%22%2C%22trans.ipXff%22%2C%5B%22192.0.2.9%22%5D%2Ctrue%5D%2C%5B%22in%22%2C%22trans.ip%22%2C%5B%22192.0.2.8%22%5D%2Ctrue%5D%2C%5B%22in%22%2C%22trans.statusCode%22%2C%5B%22100%22%5D%2Ctrue%5D%2C%5B%22in%22%2C%22trans.policyId%22%2C%5B%22waf%22%5D%2Ctrue%5D%5D", "clientIp": { "ip": "192.0.2.9", "ipLocation": { "asNumber": 9583, "city": "BANGALORE", "countryCode": "IN", "regionCode": "KA" } }, "connectingIp": { "ip": "192.0.2.9", "ipLocation": { "asNumber": 9583, "city": "BANGALORE", "countryCode": "IN", "regionCode": "KA" } }, "edgeServerIp": { "ip": "192.0.2.9", "ipLocation": { "asNumber": 9583, "city": "BANGALORE", "countryCode": "IN", "regionCode": "KA" } }, "logLines": { "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": "-" } ] }, "originIp": { "ip": "192.0.2.9", "ipLocation": { "asNumber": 9583, "city": "BANGALORE", "countryCode": "IN", "regionCode": "KA" } } } } } }, "schema": { "additionalProperties": false, "description": "Specifies the error with the specific reference code and about the request. For operations in progress, the returned object contains `retryAfter`, `requestId`, and `link`. In this case, wait for the duration of the `retryAfter` interval, then either use the `requestId` to run the [Get a translate error string response](https://techdocs.akamai.com/edge-diagnostics/reference/get-error-translator-request) operation, or simply GET the `link`.", "type": "object", "required": [ "createdBy", "createdTime", "completedTime", "executionStatus", "request" ], "properties": { "completedTime": { "description": "ISO 8601 timestamp indicating when the request was completed.", "format": "date-time", "type": "string" }, "createdBy": { "description": "Username who submitted the request.", "minLength": 1, "type": "string" }, "createdTime": { "description": "ISO 8601 timestamp indicating when the request was submitted.", "format": "date-time", "type": "string" }, "executionStatus": { "description": "Status of the request's execution. Possible values are `SUCCESS`, `FAILURE`, or `IN_PROGRESS`.", "type": "string", "enum": [ "SUCCESS", "FAILURE", "IN_PROGRESS" ] }, "link": { "description": "Link to GET the error translator response after the `retryAfter` interval passes. It occurs only for operations with the `IN_PROGRESS` status.", "minLength": 1, "type": "string" }, "request": { "additionalProperties": false, "description": "Specifies your request.", "type": "object", "required": [ "errorCode" ], "properties": { "errorCode": { "description": "Alphanumeric part of the error reference code you want to get the data for.", "minLength": 1, "type": "string" }, "traceForwardLogs": { "description": "Gets logs from all edge servers involved in serving the request. When `false`, you get logs only from the edge server where the error occurred. Tracing forward logs may prolong the time of fetching data. The default value is `false`.", "type": "boolean" } }, "x-akamai": { "file-path": "schemas/errorTranslatorRequest.yaml" } }, "requestId": { "description": "Unique identifier for the error translator request. Store this value to run [Get a translate error string response](https://techdocs.akamai.com/edge-diagnostics/reference/get-error-translator-request) operation.", "minimum": 0, "type": "integer" }, "result": { "additionalProperties": false, "description": "Specifies the error. It occurs only for operations with the `SUCCESS` status. ", "type": "object", "properties": { "cacheKeyHostname": { "description": "Cache key hostname.", "format": "hostname", "type": "string" }, "certificateErrorDetails": { "additionalProperties": false, "description": "Specifies a certificate error for 30.x.x.x error codes.", "type": "object", "required": [ "error", "solution" ], "properties": { "error": { "description": "Error details.", "type": "string" }, "fingerPrint": { "description": "Certificate fingerprint you can share with a support team to compare with the origin certificate.", "type": "string" }, "solution": { "description": "Suggested solution.", "type": "string" } }, "x-akamai": { "file-path": "schemas/certificateErrorDetails.yaml" } }, "clientIp": { "additionalProperties": false, "description": "Specifies the client that attempted to contact the edge server to request the content.", "type": "object", "required": [ "ip", "ipLocation" ], "properties": { "ip": { "description": "IP address.", "minLength": 1, "type": "string" }, "ipLocation": { "additionalProperties": false, "description": "Specifies IP's geolocation.", "type": "object", "required": [ "city", "regionCode", "countryCode", "asNumber" ], "properties": { "asNumber": { "description": "Autonomous System Number the edge IP maps to.", "minimum": 0, "type": "integer" }, "city": { "description": "Closest city within a 50-mile radius the edge IP maps to.", "minLength": 1, "type": "string" }, "countryCode": { "description": "ISO 3166 country code the edge IP maps to.", "minLength": 1, "type": "string" }, "regionCode": { "description": "ISO 3166 region code the edge IP maps to.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/edgeIpLocation.yaml" } } }, "x-akamai": { "file-path": "schemas/ipDetails.yaml" } }, "clientRequestMethod": { "description": "The HTTP method that the client requested for the URL.", "minLength": 1, "type": "string" }, "connectingIp": { "additionalProperties": false, "description": "Specifies the connecting server.", "type": "object", "required": [ "ip", "ipLocation" ], "properties": { "ip": { "description": "IP address.", "minLength": 1, "type": "string" }, "ipLocation": { "additionalProperties": false, "description": "Specifies IP's geolocation.", "type": "object", "required": [ "city", "regionCode", "countryCode", "asNumber" ], "properties": { "asNumber": { "description": "Autonomous System Number the edge IP maps to.", "minimum": 0, "type": "integer" }, "city": { "description": "Closest city within a 50-mile radius the edge IP maps to.", "minLength": 1, "type": "string" }, "countryCode": { "description": "ISO 3166 country code the edge IP maps to.", "minLength": 1, "type": "string" }, "regionCode": { "description": "ISO 3166 region code the edge IP maps to.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/edgeIpLocation.yaml" } } }, "x-akamai": { "file-path": "schemas/ipDetails.yaml" } }, "cpCode": { "description": "CP code for this request.", "minimum": 0, "type": "integer" }, "date": { "description": "ISO 8601 timestamp indicating when the request took place.", "format": "date-time", "type": "string" }, "edgeServerIp": { "additionalProperties": false, "description": "Specifies the edge server that answered the client's request or served the error.", "type": "object", "required": [ "ip", "ipLocation" ], "properties": { "ip": { "description": "IP address.", "minLength": 1, "type": "string" }, "ipLocation": { "additionalProperties": false, "description": "Specifies IP's geolocation.", "type": "object", "required": [ "city", "regionCode", "countryCode", "asNumber" ], "properties": { "asNumber": { "description": "Autonomous System Number the edge IP maps to.", "minimum": 0, "type": "integer" }, "city": { "description": "Closest city within a 50-mile radius the edge IP maps to.", "minLength": 1, "type": "string" }, "countryCode": { "description": "ISO 3166 country code the edge IP maps to.", "minLength": 1, "type": "string" }, "regionCode": { "description": "ISO 3166 region code the edge IP maps to.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/edgeIpLocation.yaml" } } }, "x-akamai": { "file-path": "schemas/ipDetails.yaml" } }, "epochTime": { "description": "When the request occurred, in epoch seconds.", "minimum": 0, "type": "integer" }, "grepUrl": { "description": "Link you can use to get log lines for specified criteria.", "minLength": 1, "type": "string" }, "httpResponseCode": { "description": "HTTP response code for this request.", "minimum": 0, "type": "integer" }, "logLines": { "additionalProperties": false, "description": "Collects log lines for this error request.", "type": "object", "required": [ "logs", "legend" ], "properties": { "legend": { "additionalProperties": false, "description": "Descriptions of returned `logType`, `objectStatus`, `objectStatus2`, `objectStatus3` in `r` and `f` log lines.", "type": "object", "required": [ "logType", "rObjectStatus", "rObjectStatus2", "rObjectStatus3", "fObjectStatus", "fObjectStatus2", "fObjectStatus3" ], "properties": { "fObjectStatus": { "description": "Descriptions of the `objectStatus` data in f-line.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } }, "fObjectStatus2": { "description": "Descriptions of the `objectStatus2` data in f-line.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } }, "fObjectStatus3": { "description": "Descriptions of the `objectStatus3` data in f-line.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } }, "logType": { "description": "Description of the `logType` data.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } }, "rObjectStatus": { "description": "Descriptions of the `objectStatus` data in r-line.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } }, "rObjectStatus2": { "description": "Descriptions of the `objectStatus2` data in r-line.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } }, "rObjectStatus3": { "description": "Descriptions of the `objectStatus3` data in r-line.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } } }, "x-akamai": { "file-path": "schemas/legend.yaml" } }, "logs": { "description": "Filtered log lines.", "minItems": 0, "type": "array", "items": { "description": "Items provided as key/value pairs.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } } } }, "x-akamai": { "file-path": "schemas/logsContainer.yaml" } }, "noLogsErrorTitle": { "description": "If logs not fetched, details of the error.", "minLength": 1, "type": "string" }, "noLogsErrorType": { "description": "If logs not fetched, type of the error.", "minLength": 1, "type": "string" }, "originIp": { "additionalProperties": false, "description": "Specifies origin server that the edge server attempted to connect to.", "type": "object", "required": [ "ip", "ipLocation" ], "properties": { "ip": { "description": "IP address.", "minLength": 1, "type": "string" }, "ipLocation": { "additionalProperties": false, "description": "Specifies IP's geolocation.", "type": "object", "required": [ "city", "regionCode", "countryCode", "asNumber" ], "properties": { "asNumber": { "description": "Autonomous System Number the edge IP maps to.", "minimum": 0, "type": "integer" }, "city": { "description": "Closest city within a 50-mile radius the edge IP maps to.", "minLength": 1, "type": "string" }, "countryCode": { "description": "ISO 3166 country code the edge IP maps to.", "minLength": 1, "type": "string" }, "regionCode": { "description": "ISO 3166 region code the edge IP maps to.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/edgeIpLocation.yaml" } } }, "x-akamai": { "file-path": "schemas/ipDetails.yaml" } }, "propertyName": { "description": "Property Manager property name applied to serve the request.", "minLength": 1, "type": "string" }, "propertyUrl": { "description": "URL assigned to the `propertyName` in Property Manager.", "minLength": 1, "type": "string" }, "reasonForFailure": { "description": "Error code returned by an edge server that explains why this transaction failed.", "minLength": 1, "type": "string" }, "url": { "description": "URL a client tried to access when the error occurred.", "minLength": 1, "type": "string" }, "userAgent": { "description": "The `User-Agent` HTTP header sent by the client to the edge server.", "minLength": 1, "type": "string" }, "wafDetails": { "description": "Details about the firewall applied to the request.", "minLength": 1, "type": "string" }, "wafDetailsUrl": { "description": "Link to Web Application Firewall (WAF) details.", "minLength": 1, "type": "string" }, "wsaUrl": { "description": "Link to Web Security Analytics (WSA) details.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/translatedError.yaml" } }, "retryAfter": { "description": "Number of seconds when the request is estimated to have processed. It occurs only for operations with the `IN_PROGRESS` status.", "minimum": 0, "type": "integer" }, "suggestedActions": { "description": "Suggestions on what to do next with the results.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } } }, "x-akamai": { "file-path": "schemas/errorTranslatorResponse.yaml" } } } }, "headers": { "X-RateLimit-Limit": { "description": "The rate limit ceiling for this endpoint.", "example": 10, "schema": { "type": "integer" }, "x-akamai": { "file-path": "headers/X-RateLimit-Limit.yaml" } }, "X-RateLimit-Remaining": { "description": "The number of requests left for the time window.", "example": 5, "schema": { "type": "integer" }, "x-akamai": { "file-path": "headers/X-RateLimit-Remaining.yaml" } } } }, "400": { "description": "[Validation error](https://techdocs.akamai.com/edge-diagnostics/reference/400).", "content": { "application/problem+json": { "example": { "detail": "Provide only one of these members, either `edgeLocationId` or `edgeIp`.", "status": 400, "title": "Incorrect request.", "type": "bad.request.error", "errors": [ { "requestField": "edgeLocationId", "title": "Conflicting values.", "type": "field.conflict" }, { "requestField": "edgeIp", "title": "Conflicting values.", "type": "field.conflict" } ] }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/400.yaml" } }, "401": { "description": "[Authorization error](https://techdocs.akamai.com/edge-diagnostics/reference/401).", "content": { "application/problem+json": { "example": { "detail": "Inactive client token", "instance": "https://akab-nedrvuylepskzabx-lv3dgceqqktx3i5b.luna.akamaiapis.net/edge-diagnostics/v1/grep/requests", "status": 401, "title": "Not authorized", "type": "https://problems.luna.akamaiapis.net/-/pep-authn/deny" }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/401.yaml" } }, "403": { "description": "[Permission error](https://techdocs.akamai.com/edge-diagnostics/reference/403).", "content": { "application/problem+json": { "example": { "status": 403, "title": "Forbidden request.", "type": "forbidden.request.error", "errors": [ { "detail": "You don't have access to the requested URL. Contact your Admin to request access.", "requestField": "url", "title": "Field access denied.", "type": "field.access.denied" } ] }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/403.yaml" } }, "404": { "description": "[Resource not found error](https://techdocs.akamai.com/edge-diagnostics/reference/404).", "content": { "application/problem+json": { "example": { "detail": "The requested resource couldn't be found. Make sure that the resource is not deleted and the ID is correct.", "status": 404, "title": "Resource not found.", "type": "resource.not.found" }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/404.yaml" } }, "405": { "description": "[Method not allowed](https://techdocs.akamai.com/edge-diagnostics/reference/405).", "content": { "application/problem+json": { "example": { "title": "Method not allowed", "type": "method.not.allowed" }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/405.yaml" } }, "429": { "description": "[Too many requests](https://techdocs.akamai.com/edge-diagnostics/reference/429).", "content": { "application/problem+json": { "example": { "detail": "You have exceeded total number of requests configured for this API.", "status": 429, "title": "Too Many Requests", "type": "requests.exceeded.error" }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/429.yaml" } } }, "parameters": [ { "description": "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ] }, "parameters": [ { "description": "Unique identifier for a request. To get this value, run the corresponding POST operation.", "example": "{{requestId}}", "in": "path", "name": "requestId", "required": true, "schema": { "example": 365, "type": "integer" }, "x-akamai": { "file-path": "parameters/requestId-path.yaml" } } ] }, "/esi-debugger-api/v1/debug": { "post": { "description": "This operation provides a debugging report on the ESI code of your source page and all pages that the source page references.", "operationId": "post-debug", "summary": "Get an ESI debugging report", "tags": [ "ESI debugger" ], "externalDocs": { "description": "See documentation for this operation in Akamai's Edge Diagnostics API", "url": "https://techdocs.akamai.com/edge-diagnostics/reference/post-debug" }, "requestBody": { "required": true, "content": { "application/json": { "example": { "clientIP": "192.0.2.0", "originServer": "example.server", "url": "https://www.example.com", "clientRequestHeaders": { "Accept": "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8;" } }, "schema": { "additionalProperties": false, "description": "Contains the POST body parameters of the request for which you request ESI debugging information.", "type": "object", "required": [ "url" ], "properties": { "clientIP": { "description": "The client IP that emulates a location for specific EdgeScape GEO (geographic) data.", "example": "{{clientIP}}", "minLength": 1, "pattern": "^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$", "type": "string" }, "clientRequestHeaders": { "description": "Custom HTTP headers used in the client's requests.", "type": "object" }, "originServer": { "description": "The test origin server where the edge server sends requests instead of the origin server.", "example": "{{originServer}}", "minLength": 1, "pattern": "^(([a-zA-Z]|[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]).)*([A-Za-z]|[A-Za-z][A-Za-z0-9-]*[A-Za-z0-9])$", "type": "string" }, "url": { "description": "The URL of the page with the ESI tags for which you request debugging information.", "example": "{{url}}", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/inputBody.yaml" } } } } }, "responses": { "200": { "description": "The response provides a debugging report.", "content": { "application/json": { "example": { "sourceDebugPage": { "pageLink": "http://www.example.com/", "enumeratedSource": [ "//1 ", "//2 ", "//3 ", "//4 ", "//5 ", "//6 1\">", "//21 ", "//22 ", "//23 ", "//24 ", "//25 ", "//26 ", "//27 ", "//28 ", "//29 ", "//30 ", "//31 ", "//32 ", "//33 ", "//34 ", "//35 ", "//36 ", "//37 ", "//38 ", "//39 " ], "environmentVariables": [ "versionPath: version", "currenthost: www.example.com", "HTTP_ACCEPT: text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8;", "HTTP_CONTENT_LENGTH: 14041", "HTTP_CONTENT_LOCATION:", "HTTP_CONTENT_TYPE: text/html; charset=UTF-8", "HTTP_HOST: www.example.com", "HTTP_REFERER:" ], "evaluatedResults": [ "[2004]: Your code ran successfully." ], "syntaxErrorMessages": [] }, "allIncludedPages": [ { "pageLink": "www.example.com/content/test.html", "enumeratedSource": [ "//1
", "//2 ", "//3
Included Page 1
" ], "environmentVariables": [ "versionPath: version", "currenthost: www.exampletest1.com" ], "evaluatedResults": [ "[2011]: The document contains no ESI tags.", "[2004]: Your code ran successfully." ], "syntaxErrorMessages": [] }, { "pageLink": "www.example.com/content/abc/esi.html", "enumeratedSource": [ "//1
", "//2 ", "//3
Included Page 2
" ], "environmentVariables": [ "versionPath: version", "currenthost: www.exampletest2.com" ], "evaluatedResults": [ "[2011]: The document contains no ESI tags.", "[2004]: Your code ran successfully." ], "syntaxErrorMessages": [] } ] }, "schema": { "additionalProperties": false, "description": "Contains ESI debugging information for the source page and the included pages.", "type": "object", "properties": { "allIncludedPages": { "description": "ESI debugging information for all the pages included in the source page's ESI code.", "type": "array", "items": { "additionalProperties": false, "description": "Contains ESI debugging information for a single page.", "type": "object", "properties": { "enumeratedSource": { "description": "The ESI source code lines with line numbers prefixed to each line.", "type": "array", "items": { "type": "string" } }, "environmentVariables": { "description": "The resulting values for the ESI-supported and user-defined variables.", "type": "array", "items": { "type": "string" } }, "evaluatedResults": { "description": "The results of evaluating the ESI source code.", "type": "array", "items": { "type": "string" } }, "pageLink": { "description": "The URL of the page.", "type": "string" }, "syntaxErrorMessages": { "description": "Information about any syntax error messages.", "type": "array", "items": { "type": "string" } } }, "x-akamai": { "file-path": "schemas/esiDebugPage.yaml" } } }, "sourceDebugPage": { "additionalProperties": false, "description": "ESI debugging information for the source page.", "type": "object", "properties": { "enumeratedSource": { "description": "The ESI source code lines with line numbers prefixed to each line.", "type": "array", "items": { "type": "string" } }, "environmentVariables": { "description": "The resulting values for the ESI-supported and user-defined variables.", "type": "array", "items": { "type": "string" } }, "evaluatedResults": { "description": "The results of evaluating the ESI source code.", "type": "array", "items": { "type": "string" } }, "pageLink": { "description": "The URL of the page.", "type": "string" }, "syntaxErrorMessages": { "description": "Information about any syntax error messages.", "type": "array", "items": { "type": "string" } } }, "x-akamai": { "file-path": "schemas/esiDebugPage.yaml" } } }, "x-akamai": { "file-path": "schemas/esiDebugReport.yaml" } } } } }, "401": { "description": "[Authorization error](https://techdocs.akamai.com/edge-diagnostics/reference/401).", "content": { "application/problem+json": { "example": { "detail": "Inactive client token", "instance": "https://akab-nedrvuylepskzabx-lv3dgceqqktx3i5b.luna.akamaiapis.net/edge-diagnostics/v1/grep/requests", "status": 401, "title": "Not authorized", "type": "https://problems.luna.akamaiapis.net/-/pep-authn/deny" }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/401.yaml" } }, "405": { "description": "[Method not allowed](https://techdocs.akamai.com/edge-diagnostics/reference/405).", "content": { "application/problem+json": { "example": { "title": "Method not allowed", "type": "method.not.allowed" }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/405.yaml" } }, "429": { "description": "[Too many requests](https://techdocs.akamai.com/edge-diagnostics/reference/429).", "content": { "application/problem+json": { "example": { "detail": "You have exceeded total number of requests configured for this API.", "status": 429, "title": "Too Many Requests", "type": "requests.exceeded.error" }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/429.yaml" } } }, "parameters": [ { "description": "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ] } }, "/estats": { "post": { "description": "Returns HTTP status codes distribution statistics from delivering a URL or CP code based on the nine-second traffic sample from the last two minutes. You can filter the results by `delivery` and `errorType`. The `delivery` is the delivery type of your resource, either `ENHANCED_TLS` or `STANDARD_TLS`. The `STANDARD_TLS` value returns data for the HTTP traffic with Standard TLS hostname, whereas `ENHANCED_TLS` for the HTTPS traffic with Enhanced TLS hostname. Without this filter, Edge Diagnostics checks on its own the type of delivery used by your resource and returns data for it. If your resource uses both delivery types, then Edge Diagnostics returns data for the type which got all data collected faster. If you choose the delivery type not used by your resource, then the results are empty. If you want to add this filter, you can run the [Get an edge hostname](https://techdocs.akamai.com/edge-hostnames/reference/get-edgehostnameid) operation in [Edge Hostnames API](https://techdocs.akamai.com/edge-hostnames/reference/api) to confirm the delivery type of your resource. It's the `securityType` value. The `errorType` filter is for the traffic's direction. The `EDGE_ERRORS` value returns data for the traffic between a customer and an edge server and `ORIGIN_ERRORS` between the edge server and the origin. Without this filter, Edge Diagnostics returns data for both directions.", "operationId": "post-estats", "summary": "Get error statistics", "tags": [ "Error statistics" ], "externalDocs": { "description": "See documentation for this operation in Akamai's Edge Diagnostics API", "url": "https://techdocs.akamai.com/edge-diagnostics/reference/post-estats" }, "requestBody": { "required": true, "content": { "application/json": { "example": { "delivery": "ENHANCED_TLS", "errorType": "EDGE_ERRORS", "url": "https://www.example.com" }, "schema": { "additionalProperties": false, "description": "Collects a URL or CP code for which you want to get the traffic's HTTP status codes distribution statistics and filters.", "minProperties": 1, "type": "object", "properties": { "cpCode": { "description": "CP code you want to get the error statistics for. You need to provide either this value or `url`.", "example": "{{cpCode}}", "minimum": 0, "type": "integer" }, "delivery": { "description": "Type of network you want to get traffic data for, either `STANDARD_TLS` or `ENHANCED_TLS`. Without this filter, Edge Diagnostics checks on its own the type of delivery used by the requested CP code or URL and returns data for it. If it uses both types, then Edge Diagnostics returns data for the type which got all data collected faster. If you choose the delivery type not used by your resource, then the results are empty. To verify the delivery type of your resource, run the [Get an edge hostname](https://techdocs.akamai.com/edge-hostnames/reference/get-edgehostnameid#getedgehostname) operation in [Edge Hostnames API](https://techdocs.akamai.com/edge-hostnames/reference/api). It is the `securityType` value.", "example": "{{delivery}}", "type": "string", "enum": [ "STANDARD_TLS", "ENHANCED_TLS" ] }, "errorType": { "description": "Type of traffic direction you want to get the data for, either `EDGE_ERRORS` or `ORIGIN_ERRORS`. The `EDGE_ERRORS` value returns data for the edge server response to a client and `ORIGIN_ERRORS` for the edge server forward request to an origin server. Without this filter, Edge Diagnostics returns data for both.", "example": "{{errorType}}", "type": "string", "enum": [ "EDGE_ERRORS", "ORIGIN_ERRORS" ] }, "url": { "description": "Fully qualified URL you want to get the error statistics for. You need to provide either this value or `cpCode`.", "example": "{{url}}", "format": "uri", "type": "string" } }, "x-akamai": { "file-path": "schemas/estatsPostRequest.yaml" }, "oneOf": [ { "title": "URL request", "required": [ "url" ] }, { "title": "CP code request", "required": [ "cpCode" ] } ] } } } }, "responses": { "200": { "description": "The response provides statistics for the requested data.", "content": { "application/json": { "example": { "completedTime": "2021-02-26T07:15:49Z", "createdBy": "tyamada", "createdTime": "2021-02-26T07:15:42Z", "executionStatus": "SUCCESS", "request": { "delivery": "ENHANCED_TLS", "url": "https://www.example.com" }, "result": { "edgeErrors": 1460, "edgeFailurePercentage": 2, "edgeHits": 79655, "originErrors": 1204, "originFailurePercentage": 1, "originHits": 82279, "edgeStatusCodeDistribution": [ { "hits": 72804, "httpStatus": 200, "percentage": 91.4 }, { "hits": 2442, "httpStatus": 204, "percentage": 3.07 } ], "originStatusCodeDistribution": [ { "hits": 76513, "httpStatus": 200, "percentage": 92.99 }, { "hits": 2402, "httpStatus": 204, "percentage": 2.92 } ], "topEdgeIpsWithError": [ { "edgeIp": "NN.NN.NN.NN", "edgeLogsLink": "/edge-diagnostics/v1/grep?edgeIp=NN.NN.NN.NN&cpCode=1234567&objectStatus=p&httpStatusCode=403&end=2021-04-21T13:42:45Z&logType=f", "errorCode": "0:None", "hits": 26, "httpStatus": 403, "edgeIpLocation": { "asNumber": 1234, "city": "TOKYO", "countryCode": "JP", "regionCode": "13" }, "objectStatus": [ { "code": "p", "description": "Another hierarchy parent edge server was contacted." } ] }, { "edgeIp": "NN.NN.NN.NN", "edgeLogsLink": "/edge-diagnostics/v1/grep?edgeIp=NN.NN.NN.NN&cpCode=1234567&objectStatus=p&httpStatusCode=403&end=2021-04-21T13:42:45Z&logType=f", "errorCode": "18:ACCESS_DENIED", "hits": 22, "httpStatus": 403, "edgeIpLocation": { "asNumber": 1234, "city": "TOKYO", "countryCode": "JP", "regionCode": "13" }, "objectStatus": [ { "code": "p", "description": "Another hierarchy parent edge server was contacted." } ] } ], "topEdgeIpsWithErrorFromOrigin": [ { "edgeIp": "NN.NN.NN.NN", "edgeLogsLink": "/edge-diagnostics/v1/grep?edgeIp=NN.NN.NN.NN&cpCode=1234567&objectStatus=p&httpStatusCode=403&end=2021-04-21T13:42:45Z&logType=r", "errorCode": "0:None", "hits": 31, "httpStatus": 403, "edgeIpLocation": { "asNumber": 1234, "city": "TOKYO", "countryCode": "JP", "regionCode": "13" }, "objectStatus": [ { "code": "p", "description": "Another hierarchy parent edge server was contacted." } ] }, { "edgeIp": "NN.NN.NN.NN", "edgeLogsLink": "/edge-diagnostics/v1/grep?edgeIp=NN.NN.NN.NN&cpCode=1234567&objectStatus=p&httpStatusCode=403&end=2021-04-21T13:42:45Z&logType=r", "errorCode": "0:None", "hits": 29, "httpStatus": 403, "edgeIpLocation": { "asNumber": 1234, "city": "TOKYO", "countryCode": "JP", "regionCode": "13" }, "objectStatus": [ { "code": "p", "description": "Another hierarchy parent edge server was contacted." } ] } ], "topEdgeIpsWithSuccess": [ { "edgeIp": "NN.NN.NN.NN", "errorCode": "0:None", "hits": 1194, "httpStatus": 200, "edgeIpLocation": { "asNumber": 1234, "city": "TOKYO", "countryCode": "JP", "regionCode": "13" }, "objectStatus": [ { "code": "p", "description": "Another hierarchy parent edge server was contacted." } ] }, { "edgeIp": "NN.NN.NN.NN", "errorCode": "0:None", "hits": 798, "httpStatus": 200, "edgeIpLocation": { "asNumber": 1234, "city": "TOKYO", "countryCode": "JP", "regionCode": "13" }, "objectStatus": [ { "code": "p", "description": "Another hierarchy parent edge server was contacted." } ] } ], "topEdgeIpsWithSuccessFromOrigin": [ { "edgeIp": "NN.NN.NN.NN", "errorCode": "0:None", "hits": 1765, "httpStatus": 200, "edgeIpLocation": { "asNumber": 1234, "city": "TOKYO", "countryCode": "JP", "regionCode": "13" }, "objectStatus": [ { "code": "p", "description": "Another hierarchy parent edge server was contacted." } ] }, { "edgeIp": "NN.NN.NN.NN", "errorCode": "0:None", "hits": 1525, "httpStatus": 200, "edgeIpLocation": { "asNumber": 1234, "city": "TOKYO", "countryCode": "JP", "regionCode": "13" }, "objectStatus": [ { "code": "p", "description": "Another hierarchy parent edge server was contacted." } ] } ] } }, "schema": { "additionalProperties": false, "description": "Collects HTTP status codes distribution statistics for the requested traffic. The content of the response differs depending on your filters from the request. If you chose `delivery` not used by your resource, then the results are empty.", "type": "object", "required": [ "request", "createdBy", "createdTime", "completedTime", "executionStatus" ], "properties": { "completedTime": { "description": "ISO 8601 timestamp indicating when the request was completed.", "format": "date-time", "type": "string" }, "createdBy": { "description": "Username who submitted the request.", "minLength": 1, "type": "string" }, "createdTime": { "description": "ISO 8601 timestamp indicating when the request was submitted.", "format": "date-time", "type": "string" }, "executionStatus": { "description": "Status of the request's execution, either `SUCCESS` or `FAILURE`.", "type": "string", "enum": [ "SUCCESS", "FAILURE" ] }, "request": { "additionalProperties": false, "description": "Specifies your request.", "minProperties": 1, "type": "object", "properties": { "cpCode": { "description": "CP code you want to get the error statistics for. You need to provide either this value or `url`.", "minimum": 0, "type": "integer" }, "delivery": { "description": "Type of network you want to get traffic data for, either `STANDARD_TLS` or `ENHANCED_TLS`. The `STANDARD_TLS` value provides HTTP traffic data for Standard TLS hostnames and `ENHANCED_TLS` provides HTTPS traffic data for Enhanced TLS hostnames. Without this filter, Edge Diagnostics checks on its own the type of delivery used by your resource and returns data for it. If your resource uses both delivery types, then Edge Diagnostics returns data for the type which got all data collected faster. If you choose the delivery type not used by your resource, then the results are empty. To verify the delivery type of you resource, run the [Get an edge hostname](https://techdocs.akamai.com/edge-hostnames/reference/get-edgehostnameid) operation in [Edge Hostnames API](https://techdocs.akamai.com/edge-hostnames/reference/api). It's the `securityType` value.", "type": "string", "enum": [ "STANDARD_TLS", "ENHANCED_TLS" ] }, "errorType": { "description": "Type of traffic direction you want to get the data for, either `EDGE_ERRORS` or `ORIGIN_ERRORS`. The `EDGE_ERRORS` value returns data for the edge server response to a client and `ORIGIN_ERRORS` for the edge server forward request to an origin server. Without this filter, Edge Diagnostics returns data for both.", "type": "string", "enum": [ "EDGE_ERRORS", "ORIGIN_ERRORS" ] }, "url": { "description": "Fully qualified URL you want to get the error statistics for. You need to provide either this value or `cpCode`.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/estatsRequest.yaml" }, "oneOf": [ { "title": "URL request", "required": [ "url" ] }, { "title": "CP code request", "required": [ "cpCode" ] } ] }, "result": { "additionalProperties": false, "description": "Provides HTTP status codes distribution statistics for the requested traffic.", "minProperties": 1, "type": "object", "properties": { "edgeErrors": { "description": "Total number of error responses from an edge server to a client. It doesn't appear if you filtered the results for the `origin` network type.", "minimum": 0, "type": "integer" }, "edgeFailurePercentage": { "description": "Percentage of error responses from an edge server to a client in the whole traffic, maximum `100`. It doesn't appear if you filtered the results for the `origin` network type.", "maximum": 100, "minimum": 0, "type": "integer" }, "edgeHits": { "description": "Total number of responses from an edge server to a client. It doesn't appear if you filtered the results for the `origin` network type.", "minimum": 0, "type": "integer" }, "edgeStatusCodeDistribution": { "description": "Lists HTTP status codes distribution statistics for edge server responses to a client. It doesn't appear if you filtered the results for the `origin` network type.", "minItems": 0, "type": "array", "items": { "additionalProperties": false, "description": "Collects percentages and total hits for each status code.", "type": "object", "required": [ "hits", "percentage", "httpStatus" ], "properties": { "hits": { "description": "The total number of hits per `httpStatus`.", "minimum": 0, "type": "integer" }, "httpStatus": { "description": "The HTTP status code to which the number of `hits` and overall `percentage` apply.", "minimum": 0, "type": "integer" }, "percentage": { "description": "The percentage of all traffic for this `httpStatus`, maximum `100`.", "maximum": 100, "minimum": 0, "type": "number" } }, "x-akamai": { "file-path": "schemas/statusCodeDistribution.yaml" } } }, "originErrors": { "description": "Total number of error responses for edge server forward requests to an origin server. It doesn't appear if you filtered the results for the `edge` network type.", "minimum": 0, "type": "integer" }, "originFailurePercentage": { "description": "Percentage of error responses for edge server forward requests to an origin server in the whole traffic, maximum `100`. It doesn't appear if you filtered the results for the `edge` network type.", "maximum": 100, "minimum": 0, "type": "integer" }, "originHits": { "description": "Total number of forward requests from an edge server to an origin server. It doesn't appear if you filtered the results for the `edge` network type.", "minimum": 0, "type": "integer" }, "originStatusCodeDistribution": { "description": "Lists HTTP status codes distribution statistics for edge server forward requests to an origin server. It doesn't appear if you filtered the results for the `edge` network type.", "minItems": 0, "type": "array", "items": { "additionalProperties": false, "description": "Collects percentages and total hits for each status code.", "type": "object", "required": [ "hits", "percentage", "httpStatus" ], "properties": { "hits": { "description": "The total number of hits per `httpStatus`.", "minimum": 0, "type": "integer" }, "httpStatus": { "description": "The HTTP status code to which the number of `hits` and overall `percentage` apply.", "minimum": 0, "type": "integer" }, "percentage": { "description": "The percentage of all traffic for this `httpStatus`, maximum `100`.", "maximum": 100, "minimum": 0, "type": "number" } }, "x-akamai": { "file-path": "schemas/statusCodeDistribution.yaml" } } }, "topEdgeIpsWithError": { "description": "Lists top IPs with errors in edge server responses to a client. It doesn't appear if you filtered the results for the `origin` network type.", "minItems": 0, "type": "array", "items": { "additionalProperties": false, "description": "Collects error statistics for a single IP address.", "type": "object", "required": [ "edgeIp", "errorCode", "hits", "httpStatus", "objectStatus", "edgeIpLocation" ], "properties": { "edgeIp": { "description": "One of the top edge IP addresses returning errors.", "type": "string" }, "edgeIpLocation": { "additionalProperties": false, "description": "Specifies edge IP's geolocation.", "type": "object", "required": [ "city", "regionCode", "countryCode", "asNumber" ], "properties": { "asNumber": { "description": "Autonomous System Number the edge IP maps to.", "minimum": 0, "type": "integer" }, "city": { "description": "Closest city within a 50-mile radius the edge IP maps to.", "minLength": 1, "type": "string" }, "countryCode": { "description": "ISO 3166 country code the edge IP maps to.", "minLength": 1, "type": "string" }, "regionCode": { "description": "ISO 3166 region code the edge IP maps to.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/edgeIpLocation.yaml" } }, "edgeLogsLink": { "description": "Link you can use to get log lines for the edge IP.", "type": "string" }, "errorCode": { "description": "Detailed error message if applicable. See [Error codes](https://techdocs.akamai.com/edge-diagnostics/docs/error-codes) for details.", "type": "string" }, "hits": { "description": "Total number of hits for the edge IP.", "type": "integer" }, "httpStatus": { "description": "HTTP status code for the measured success or error case.", "type": "integer" }, "objectStatus": { "description": "Lists object status.", "type": "array", "items": { "additionalProperties": false, "description": "The status of the object, represented as a combination of single-letter codes for all statuses that apply. For the full list of possible `codes` and `descriptions`, check [Object status codes](https://techdocs.akamai.com/edge-diagnostics/docs/object-status).", "type": "object", "required": [ "description", "code" ], "properties": { "code": { "description": "Status code.", "minLength": 1, "type": "string" }, "description": { "description": "Status description.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/objectStatus.yaml" } } } }, "x-akamai": { "file-path": "schemas/edgeIpInfo.yaml" } } }, "topEdgeIpsWithErrorFromOrigin": { "description": "Lists top IPs with errors in edge server forward requests to an origin server. It doesn't appear if you filtered the results for the `edge` network type.", "minItems": 0, "type": "array", "items": { "additionalProperties": false, "description": "Collects error statistics for a single IP address.", "type": "object", "required": [ "edgeIp", "errorCode", "hits", "httpStatus", "objectStatus", "edgeIpLocation" ], "properties": { "edgeIp": { "description": "One of the top edge IP addresses returning errors.", "type": "string" }, "edgeIpLocation": { "additionalProperties": false, "description": "Specifies edge IP's geolocation.", "type": "object", "required": [ "city", "regionCode", "countryCode", "asNumber" ], "properties": { "asNumber": { "description": "Autonomous System Number the edge IP maps to.", "minimum": 0, "type": "integer" }, "city": { "description": "Closest city within a 50-mile radius the edge IP maps to.", "minLength": 1, "type": "string" }, "countryCode": { "description": "ISO 3166 country code the edge IP maps to.", "minLength": 1, "type": "string" }, "regionCode": { "description": "ISO 3166 region code the edge IP maps to.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/edgeIpLocation.yaml" } }, "edgeLogsLink": { "description": "Link you can use to get log lines for the edge IP.", "type": "string" }, "errorCode": { "description": "Detailed error message if applicable. See [Error codes](https://techdocs.akamai.com/edge-diagnostics/docs/error-codes) for details.", "type": "string" }, "hits": { "description": "Total number of hits for the edge IP.", "type": "integer" }, "httpStatus": { "description": "HTTP status code for the measured success or error case.", "type": "integer" }, "objectStatus": { "description": "Lists object status.", "type": "array", "items": { "additionalProperties": false, "description": "The status of the object, represented as a combination of single-letter codes for all statuses that apply. For the full list of possible `codes` and `descriptions`, check [Object status codes](https://techdocs.akamai.com/edge-diagnostics/docs/object-status).", "type": "object", "required": [ "description", "code" ], "properties": { "code": { "description": "Status code.", "minLength": 1, "type": "string" }, "description": { "description": "Status description.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/objectStatus.yaml" } } } }, "x-akamai": { "file-path": "schemas/edgeIpInfo.yaml" } } }, "topEdgeIpsWithSuccess": { "description": "Lists top IPs with successful responses from an edge server to a client. It doesn't appear if you filtered the results for the `origin` network type.", "minItems": 0, "type": "array", "items": { "additionalProperties": false, "description": "Collects error statistics for a single IP address.", "type": "object", "required": [ "edgeIp", "errorCode", "hits", "httpStatus", "objectStatus", "edgeIpLocation" ], "properties": { "edgeIp": { "description": "One of the top edge IP addresses returning errors.", "type": "string" }, "edgeIpLocation": { "additionalProperties": false, "description": "Specifies edge IP's geolocation.", "type": "object", "required": [ "city", "regionCode", "countryCode", "asNumber" ], "properties": { "asNumber": { "description": "Autonomous System Number the edge IP maps to.", "minimum": 0, "type": "integer" }, "city": { "description": "Closest city within a 50-mile radius the edge IP maps to.", "minLength": 1, "type": "string" }, "countryCode": { "description": "ISO 3166 country code the edge IP maps to.", "minLength": 1, "type": "string" }, "regionCode": { "description": "ISO 3166 region code the edge IP maps to.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/edgeIpLocation.yaml" } }, "edgeLogsLink": { "description": "Link you can use to get log lines for the edge IP.", "type": "string" }, "errorCode": { "description": "Detailed error message if applicable. See [Error codes](https://techdocs.akamai.com/edge-diagnostics/docs/error-codes) for details.", "type": "string" }, "hits": { "description": "Total number of hits for the edge IP.", "type": "integer" }, "httpStatus": { "description": "HTTP status code for the measured success or error case.", "type": "integer" }, "objectStatus": { "description": "Lists object status.", "type": "array", "items": { "additionalProperties": false, "description": "The status of the object, represented as a combination of single-letter codes for all statuses that apply. For the full list of possible `codes` and `descriptions`, check [Object status codes](https://techdocs.akamai.com/edge-diagnostics/docs/object-status).", "type": "object", "required": [ "description", "code" ], "properties": { "code": { "description": "Status code.", "minLength": 1, "type": "string" }, "description": { "description": "Status description.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/objectStatus.yaml" } } } }, "x-akamai": { "file-path": "schemas/edgeIpInfo.yaml" } } }, "topEdgeIpsWithSuccessFromOrigin": { "description": "Lists top IPs with successful forward requests from an edge server to an origin server. It doesn't appear if you filtered the results for the `edge` network type.", "minItems": 0, "type": "array", "items": { "additionalProperties": false, "description": "Collects error statistics for a single IP address.", "type": "object", "required": [ "edgeIp", "errorCode", "hits", "httpStatus", "objectStatus", "edgeIpLocation" ], "properties": { "edgeIp": { "description": "One of the top edge IP addresses returning errors.", "type": "string" }, "edgeIpLocation": { "additionalProperties": false, "description": "Specifies edge IP's geolocation.", "type": "object", "required": [ "city", "regionCode", "countryCode", "asNumber" ], "properties": { "asNumber": { "description": "Autonomous System Number the edge IP maps to.", "minimum": 0, "type": "integer" }, "city": { "description": "Closest city within a 50-mile radius the edge IP maps to.", "minLength": 1, "type": "string" }, "countryCode": { "description": "ISO 3166 country code the edge IP maps to.", "minLength": 1, "type": "string" }, "regionCode": { "description": "ISO 3166 region code the edge IP maps to.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/edgeIpLocation.yaml" } }, "edgeLogsLink": { "description": "Link you can use to get log lines for the edge IP.", "type": "string" }, "errorCode": { "description": "Detailed error message if applicable. See [Error codes](https://techdocs.akamai.com/edge-diagnostics/docs/error-codes) for details.", "type": "string" }, "hits": { "description": "Total number of hits for the edge IP.", "type": "integer" }, "httpStatus": { "description": "HTTP status code for the measured success or error case.", "type": "integer" }, "objectStatus": { "description": "Lists object status.", "type": "array", "items": { "additionalProperties": false, "description": "The status of the object, represented as a combination of single-letter codes for all statuses that apply. For the full list of possible `codes` and `descriptions`, check [Object status codes](https://techdocs.akamai.com/edge-diagnostics/docs/object-status).", "type": "object", "required": [ "description", "code" ], "properties": { "code": { "description": "Status code.", "minLength": 1, "type": "string" }, "description": { "description": "Status description.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/objectStatus.yaml" } } } }, "x-akamai": { "file-path": "schemas/edgeIpInfo.yaml" } } } }, "x-akamai": { "file-path": "schemas/estatsData.yaml" } } }, "x-akamai": { "file-path": "schemas/estats.yaml" } } } }, "headers": { "X-RateLimit-Limit": { "description": "The rate limit ceiling for this endpoint.", "example": 10, "schema": { "type": "integer" }, "x-akamai": { "file-path": "headers/X-RateLimit-Limit.yaml" } }, "X-RateLimit-Remaining": { "description": "The number of requests left for the time window.", "example": 5, "schema": { "type": "integer" }, "x-akamai": { "file-path": "headers/X-RateLimit-Remaining.yaml" } } } }, "400": { "description": "[Validation error](https://techdocs.akamai.com/edge-diagnostics/reference/400).", "content": { "application/problem+json": { "example": { "detail": "Provide only one of these members, either `edgeLocationId` or `edgeIp`.", "status": 400, "title": "Incorrect request.", "type": "bad.request.error", "errors": [ { "requestField": "edgeLocationId", "title": "Conflicting values.", "type": "field.conflict" }, { "requestField": "edgeIp", "title": "Conflicting values.", "type": "field.conflict" } ] }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/400.yaml" } }, "401": { "description": "[Authorization error](https://techdocs.akamai.com/edge-diagnostics/reference/401).", "content": { "application/problem+json": { "example": { "detail": "Inactive client token", "instance": "https://akab-nedrvuylepskzabx-lv3dgceqqktx3i5b.luna.akamaiapis.net/edge-diagnostics/v1/grep/requests", "status": 401, "title": "Not authorized", "type": "https://problems.luna.akamaiapis.net/-/pep-authn/deny" }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/401.yaml" } }, "403": { "description": "[Permission error](https://techdocs.akamai.com/edge-diagnostics/reference/403).", "content": { "application/problem+json": { "example": { "status": 403, "title": "Forbidden request.", "type": "forbidden.request.error", "errors": [ { "detail": "You don't have access to the requested URL. Contact your Admin to request access.", "requestField": "url", "title": "Field access denied.", "type": "field.access.denied" } ] }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/403.yaml" } }, "405": { "description": "[Method not allowed](https://techdocs.akamai.com/edge-diagnostics/reference/405).", "content": { "application/problem+json": { "example": { "title": "Method not allowed", "type": "method.not.allowed" }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/405.yaml" } }, "429": { "description": "[Too many requests](https://techdocs.akamai.com/edge-diagnostics/reference/429).", "content": { "application/problem+json": { "example": { "detail": "You have exceeded total number of requests configured for this API.", "status": 429, "title": "Too Many Requests", "type": "requests.exceeded.error" }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/429.yaml" } } }, "parameters": [ { "description": "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ] } }, "/grep": { "post": { "description": "Launches an [asynchronous](https://techdocs.akamai.com/edge-diagnostics/reference/asynchronous-processes) request to fetch logs for an edge server IP address using the `grep` command. To verify if an IP belongs to an edge server, run the [Verify an IP](https://techdocs.akamai.com/edge-diagnostics/reference/post-verify-edge-ip) operation first. If you known the exact values to filter the logs by and you want to get the data directly, run the synchronous [Get specific logs](https://techdocs.akamai.com/edge-diagnostics/reference/get-grep) operation.", "operationId": "post-grep", "summary": "Launch a GREP request", "tags": [ "Grep" ], "externalDocs": { "description": "See documentation for this operation in Akamai's Edge Diagnostics API", "url": "https://techdocs.akamai.com/edge-diagnostics/reference/post-grep" }, "requestBody": { "required": true, "content": { "application/json": { "example": { "edgeIp": "192.0.2.0", "end": "2022-03-15T06:08:43.000Z", "logType": "BOTH", "start": "2022-03-15T06:08:40.000Z", "clientIps": [ "192.0.2.9" ], "cpCodes": [ 1234567 ], "userAgents": [ "firefox" ], "arls": { "comparison": "CONTAINS", "value": [ "freeflow.mdt.akamai.com/TopLevel.incr.idx" ] }, "httpStatusCodes": { "comparison": "EQUALS", "value": [ "200", "201" ] } }, "schema": { "additionalProperties": false, "description": "Collects data to use in the asynchronous `grep` request.", "type": "object", "required": [ "edgeIp", "logType", "start", "end" ], "properties": { "arls": { "additionalProperties": false, "description": "Collects ARLs to filter the logs by.", "type": "object", "required": [ "comparison", "value" ], "properties": { "comparison": { "description": "Comparison filter type. Possible values are either `CONTAINS` if you want to get the logs for specific `value` or `NOT_CONTAINS` if you want to exclude specific `value` from logs.", "type": "string", "enum": [ "CONTAINS", "NOT_CONTAINS" ] }, "value": { "description": "Lists ARLs to filter the logs by in relation to the `comparison` value.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } } }, "x-akamai": { "file-path": "schemas/arls.yaml" } }, "clientIps": { "description": "Lists client IPs to filter the logs by.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } }, "cpCodes": { "description": "Lists CP codes you want to get the logs for. You need to provide either this value or `hostnames`.", "minItems": 0, "type": "array", "items": { "minimum": 0, "type": "integer" } }, "edgeIp": { "description": "Edge IP you want to get the logs for. If you don't know if an IP is the edge IP, run the [Verify an IP](https://techdocs.akamai.com/edge-diagnostics/reference/post-verify-edge-ip) operation first. You can use the edge server IP value from the `answerSection` array in the [Get domain details with dig](https://techdocs.akamai.com/edge-diagnostics/reference/post-dig) operation response or the `ip` value from the `edgeIps` array in the [collected diagnostic data](https://techdocs.akamai.com/edge-diagnostics/reference/get-user-diagnostic-data-group-records).", "example": "{{edgeIp}}", "minLength": 1, "type": "string" }, "end": { "description": "ISO 8601 timestamp for a point of time in the past when the log search window ends.", "example": "{{end}}", "format": "date-time", "type": "string" }, "hostnames": { "description": "Lists hostnames you want to get the logs for. You need to provide either this value or `cpCodes`.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } }, "httpStatusCodes": { "additionalProperties": false, "description": "Filters the logs by specific HTTP status codes.", "type": "object", "required": [ "comparison", "value" ], "properties": { "comparison": { "description": "Comparison filter type. Possible values are either `EQUALS` if you want to get the logs for specific `value` or `NOT_EQUALS` if you want to exclude specific `value` from logs.", "type": "string", "enum": [ "EQUALS", "NOT_EQUALS" ] }, "value": { "description": "Lists HTTP status codes to filter the logs by in relation to the `comparison` value.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } } }, "x-akamai": { "file-path": "schemas/httpStatusCodes.yaml" } }, "logType": { "description": "Log record type you want to get. Possible values are: `R` for client requests to an edge server, `F` for forward requests from an edge server to the origin, or `BOTH`.", "example": "{{logType}}", "type": "string", "enum": [ "R", "F", "BOTH" ] }, "start": { "description": "ISO 8601 timestamp for a point of time in the past when the log search window starts. You can get the logs from either the last 6 or 24 hours depending on the server and traffic conditions. The recommended 10-minute periods ensure that data fetches quickly and you get the most relevant logs.", "example": "{{start}}", "format": "date-time", "type": "string" }, "userAgents": { "description": "Lists user agents to filter the logs by.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } } }, "x-akamai": { "file-path": "schemas/grepRequest.yaml" } } } } }, "responses": { "202": { "description": "Process successfully launched.", "content": { "application/json": { "example": { "completedTime": "2021-04-15T07:49:15Z", "createdBy": "mrossi", "createdTime": "2021-04-15T07:48:30Z", "executionStatus": "SUCCESS", "logLinesCount": 2, "requestId": 365, "suggestedActions": [ "Check for long times.", "Check content length/bytes served." ], "edgeIpLocation": { "asNumber": 9498, "city": "BANGALORE", "countryCode": "IN", "regionCode": "KA" }, "request": { "edgeIp": "192.0.2.0", "end": "2022-03-15T06:08:43.000Z", "logType": "BOTH", "start": "2022-03-15T06:08:40.000Z", "clientIps": [ "192.0.2.9" ], "cpCodes": [ 1234567 ], "userAgents": [ "firefox" ], "arls": { "comparison": "CONTAINS", "value": [ "freeflow.mdt.akamai.com/TopLevel.incr.idx" ] }, "httpStatusCodes": { "comparison": "EQUALS", "value": [ "200", "201" ] } }, "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": "-" } ] } }, "schema": { "additionalProperties": false, "description": "Collects the `grep` response and details about the request.", "type": "object", "required": [ "request", "requestId", "executionStatus", "createdBy", "createdTime" ], "properties": { "completedTime": { "description": "ISO 8601 timestamp indicating when the request was completed.", "format": "date-time", "type": "string" }, "createdBy": { "description": "Username who submitted the request.", "minLength": 1, "type": "string" }, "createdTime": { "description": "ISO 8601 timestamp indicating when the request was submitted.", "format": "date-time", "type": "string" }, "edgeIpLocation": { "additionalProperties": false, "description": "Lists geolocation data of the edge IP used to get the data.", "type": "object", "required": [ "city", "regionCode", "countryCode", "asNumber" ], "properties": { "asNumber": { "description": "Autonomous System Number the edge IP maps to.", "minimum": 0, "type": "integer" }, "city": { "description": "Closest city within a 50-mile radius the edge IP maps to.", "minLength": 1, "type": "string" }, "countryCode": { "description": "ISO 3166 country code the edge IP maps to.", "minLength": 1, "type": "string" }, "regionCode": { "description": "ISO 3166 region code the edge IP maps to.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/edgeIpLocation.yaml" } }, "errorResponse": { "additionalProperties": false, "description": "Specifies the reason for `FAILURE` status.", "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Details about the error.", "minLength": 1, "type": "string" }, "errors": { "description": "Collects information about problems occurred while fetching the data.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } }, "status": { "description": "Error status code.", "minLength": 1, "type": "string" }, "title": { "description": "Error title.", "minLength": 1, "type": "string" }, "type": { "description": "Error type.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/errorResponse.yaml" } }, "executionStatus": { "description": "Status of the request's execution. For the POST operation, possible options are `SUCCESS`, `FAILURE`, or `PARTIAL_SUCCESS`. Check the `warning` array, to learn about the reasons behind `PARTIAL_SUCCESS` and `errorResponse` for `FAILURE` reason. For the GET operation, possible values are either `SUCCESS` or `FAILURE`.", "type": "string", "enum": [ "SUCCESS", "FAILURE", "PARTIAL_SUCCESS" ] }, "link": { "description": "Link to GET fetched GREP data after the `retryAfter` interval passes. It occurs only for operations with the `IN_PROGRESS` status.", "minLength": 1, "type": "string" }, "logLinesCount": { "description": "Number of fetched logs.", "minimum": 0, "type": "integer" }, "request": { "additionalProperties": false, "description": "Specifies your asynchronous `grep` request.", "type": "object", "required": [ "edgeIp", "logType", "start", "end" ], "properties": { "arls": { "additionalProperties": false, "description": "Collects ARLs to filter the logs by.", "type": "object", "required": [ "comparison", "value" ], "properties": { "comparison": { "description": "Comparison filter type. Possible values are either `CONTAINS` if you want to get the logs for specific `value` or `NOT_CONTAINS` if you want to exclude specific `value` from logs.", "type": "string", "enum": [ "CONTAINS", "NOT_CONTAINS" ] }, "value": { "description": "Lists ARLs to filter the logs by in relation to the `comparison` value.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } } }, "x-akamai": { "file-path": "schemas/arls.yaml" } }, "clientIps": { "description": "Lists client IPs to filter the logs by.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } }, "cpCodes": { "description": "Lists CP codes you want to get the logs for. You need to provide either this value or `hostnames`.", "minItems": 0, "type": "array", "items": { "minimum": 0, "type": "integer" } }, "edgeIp": { "description": "Edge IP you want to get the logs for. If you don't know if an IP is the edge IP, run the [Verify an IP](https://techdocs.akamai.com/edge-diagnostics/reference/post-verify-edge-ip) operation first. You can use the edge server IP value from the `answerSection` array in the [Get domain details with dig](https://techdocs.akamai.com/edge-diagnostics/reference/post-dig) operation response or the `ip` value from the `edgeIps` array in the [collected diagnostic data](https://techdocs.akamai.com/edge-diagnostics/reference/get-user-diagnostic-data-group-records).", "minLength": 1, "type": "string" }, "end": { "description": "ISO 8601 timestamp for a point of time in the past when the log search window ends.", "format": "date-time", "type": "string" }, "hostnames": { "description": "Lists hostnames you want to get the logs for. You need to provide either this value or `cpCodes`.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } }, "httpStatusCodes": { "additionalProperties": false, "description": "Filters the logs by specific HTTP status codes.", "type": "object", "required": [ "comparison", "value" ], "properties": { "comparison": { "description": "Comparison filter type. Possible values are either `EQUALS` if you want to get the logs for specific `value` or `NOT_EQUALS` if you want to exclude specific `value` from logs.", "type": "string", "enum": [ "EQUALS", "NOT_EQUALS" ] }, "value": { "description": "Lists HTTP status codes to filter the logs by in relation to the `comparison` value.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } } }, "x-akamai": { "file-path": "schemas/httpStatusCodes.yaml" } }, "logType": { "description": "Log record type you want to get. Possible values are: `R` for client requests to an edge server, `F` for forward requests from an edge server to the origin, or `BOTH`.", "type": "string", "enum": [ "R", "F", "BOTH" ] }, "start": { "description": "ISO 8601 timestamp for a point of time in the past when the log search window starts. You can get the logs from either the last 6 or 24 hours depending on the server and traffic conditions. The recommended 10-minute periods ensure that data fetches quickly and you get the most relevant logs.", "format": "date-time", "type": "string" }, "userAgents": { "description": "Lists user agents to filter the logs by.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } } }, "x-akamai": { "file-path": "schemas/grepRequest.yaml" } }, "requestId": { "description": "Unique identifier for the `grep` request. Store this value to run [Check a GREP request status](https://techdocs.akamai.com/edge-diagnostics/reference/get-grep-request) operation.", "minimum": 0, "type": "integer" }, "result": { "additionalProperties": false, "description": "Collects fetched logs.", "type": "object", "required": [ "logs", "legend" ], "properties": { "legend": { "additionalProperties": false, "description": "Descriptions of returned `logType`, `objectStatus`, `objectStatus2`, `objectStatus3` in `r` and `f` log lines.", "type": "object", "required": [ "logType", "rObjectStatus", "rObjectStatus2", "rObjectStatus3", "fObjectStatus", "fObjectStatus2", "fObjectStatus3" ], "properties": { "fObjectStatus": { "description": "Descriptions of the `objectStatus` data in f-line.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } }, "fObjectStatus2": { "description": "Descriptions of the `objectStatus2` data in f-line.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } }, "fObjectStatus3": { "description": "Descriptions of the `objectStatus3` data in f-line.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } }, "logType": { "description": "Description of the `logType` data.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } }, "rObjectStatus": { "description": "Descriptions of the `objectStatus` data in r-line.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } }, "rObjectStatus2": { "description": "Descriptions of the `objectStatus2` data in r-line.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } }, "rObjectStatus3": { "description": "Descriptions of the `objectStatus3` data in r-line.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } } }, "x-akamai": { "file-path": "schemas/legend.yaml" } }, "logs": { "description": "Filtered log lines.", "minItems": 0, "type": "array", "items": { "description": "Items provided as key/value pairs.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } } } }, "x-akamai": { "file-path": "schemas/logsContainer.yaml" } }, "retryAfter": { "description": "Number of seconds when the request is estimated to have processed. It occurs only for operations with the `IN_PROGRESS` status.", "minimum": 0, "type": "integer" }, "suggestedActions": { "description": "Suggestions on what to do next with the results.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } }, "warning": { "additionalProperties": false, "description": "Reasons why `executionStatus` is `PARTIAL_SUCCESS`.", "type": "object", "required": [ "key", "message" ], "properties": { "key": { "description": "Unique key representing the warning message.", "minLength": 1, "type": "string" }, "message": { "description": "Warning message for the `grep` request.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/warning.yaml" } } }, "x-akamai": { "file-path": "schemas/grepResponse.yaml" } } } }, "headers": { "X-RateLimit-Limit": { "description": "The rate limit ceiling for this endpoint.", "example": 10, "schema": { "type": "integer" }, "x-akamai": { "file-path": "headers/X-RateLimit-Limit.yaml" } }, "X-RateLimit-Remaining": { "description": "The number of requests left for the time window.", "example": 5, "schema": { "type": "integer" }, "x-akamai": { "file-path": "headers/X-RateLimit-Remaining.yaml" } } } }, "400": { "description": "[Validation error](https://techdocs.akamai.com/edge-diagnostics/reference/400).", "content": { "application/problem+json": { "example": { "detail": "Provide only one of these members, either `edgeLocationId` or `edgeIp`.", "status": 400, "title": "Incorrect request.", "type": "bad.request.error", "errors": [ { "requestField": "edgeLocationId", "title": "Conflicting values.", "type": "field.conflict" }, { "requestField": "edgeIp", "title": "Conflicting values.", "type": "field.conflict" } ] }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/400.yaml" } }, "401": { "description": "[Authorization error](https://techdocs.akamai.com/edge-diagnostics/reference/401).", "content": { "application/problem+json": { "example": { "detail": "Inactive client token", "instance": "https://akab-nedrvuylepskzabx-lv3dgceqqktx3i5b.luna.akamaiapis.net/edge-diagnostics/v1/grep/requests", "status": 401, "title": "Not authorized", "type": "https://problems.luna.akamaiapis.net/-/pep-authn/deny" }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/401.yaml" } }, "403": { "description": "[Permission error](https://techdocs.akamai.com/edge-diagnostics/reference/403).", "content": { "application/problem+json": { "example": { "status": 403, "title": "Forbidden request.", "type": "forbidden.request.error", "errors": [ { "detail": "You don't have access to the requested URL. Contact your Admin to request access.", "requestField": "url", "title": "Field access denied.", "type": "field.access.denied" } ] }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/403.yaml" } }, "405": { "description": "[Method not allowed](https://techdocs.akamai.com/edge-diagnostics/reference/405).", "content": { "application/problem+json": { "example": { "title": "Method not allowed", "type": "method.not.allowed" }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/405.yaml" } }, "429": { "description": "[Too many requests](https://techdocs.akamai.com/edge-diagnostics/reference/429).", "content": { "application/problem+json": { "example": { "detail": "You have exceeded total number of requests configured for this API.", "status": 429, "title": "Too Many Requests", "type": "requests.exceeded.error" }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/429.yaml" } } }, "parameters": [ { "description": "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ] }, "get": { "description": "Using the `grep` command, returns logs that match the query parameters. This operation gets the data directly. If you don't have detailed information about the logs or you want to avoid latency, run the [Launch a GREP request](https://techdocs.akamai.com/edge-diagnostics/reference/post-grep) operation. If you provide request parameters for which Edge Diagnostics doesn't find logs, you get the validation error.", "operationId": "get-grep", "summary": "Get specific logs", "tags": [ "Grep" ], "externalDocs": { "description": "See documentation for this operation in Akamai's Edge Diagnostics API", "url": "https://techdocs.akamai.com/edge-diagnostics/reference/get-grep" }, "responses": { "200": { "description": "The response provides the `grep` results and details about the request.", "content": { "application/json": { "example": { "createdBy": "jperez", "createdTime": "2021-04-15T07:48:30Z", "executionStatus": "SUCCESS", "logLinesCount": 2, "suggestedActions": [ "Check for long times.", "Check content length/bytes served." ], "request": { "edgeIp": "192.0.2.0", "end": "2022-03-15T06:08:43.000Z", "logType": "R", "objectStatus": "pxR", "start": "2022-03-15T06:08:40.000Z", "cpCodes": [ 1234567 ], "httpStatusCodes": { "comparison": "EQUALS", "value": [ "400" ] } }, "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": "-" } ] } }, "schema": { "additionalProperties": false, "description": "Results for synchronous `grep` request.", "type": "object", "required": [ "executionStatus", "createdBy", "createdTime", "request" ], "properties": { "createdBy": { "description": "Username who submitted the request.", "minLength": 1, "type": "string" }, "createdTime": { "description": "ISO 8601 timestamp indicating when the request was submitted.", "format": "date-time", "type": "string" }, "executionStatus": { "description": "Status of the request's execution. For the POST operation, possible options are `SUCCESS`, `FAILURE`, or `PARTIAL_SUCCESS`. Check the `warning` array, to learn about the reasons behind `PARTIAL_SUCCESS`. For the GET operation, possible values are either `SUCCESS` or `FAILURE`.", "type": "string", "enum": [ "SUCCESS", "FAILURE" ] }, "logLinesCount": { "description": "Number of fetched logs.", "minimum": 0, "type": "integer" }, "request": { "additionalProperties": false, "description": "Specifies your synchronous `grep` request.", "type": "object", "required": [ "cpCodes", "edgeIp", "end" ], "properties": { "cpCodes": { "description": "Lists CP codes you want to get the logs for.", "minItems": 0, "type": "array", "items": { "minimum": 0, "type": "integer" } }, "edgeIp": { "description": "Edge IP you want to get the logs for. If you don't know if an IP is the edge IP, run the [Verify an IP](https://techdocs.akamai.com/edge-diagnostics/reference/post-verify-edge-ip) operation first.", "minLength": 1, "type": "string" }, "end": { "description": "ISO 8601 timestamp for a point of time in the past when the log search window ends.", "format": "date-time", "type": "string" }, "httpStatusCodes": { "additionalProperties": false, "description": "Collects HTTP status code to filter the logs by.", "type": "object", "required": [ "comparison", "value" ], "properties": { "comparison": { "description": "Comparison filter type. Possible values are either `EQUALS` if you want to get the logs for specific `value` or `NOT_EQUALS` if you want to exclude specific `value` from logs.", "type": "string", "enum": [ "EQUALS", "NOT_EQUALS" ] }, "value": { "description": "Lists HTTP status codes to filter the logs by in relation to the `comparison` value.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } } }, "x-akamai": { "file-path": "schemas/httpStatusCodes.yaml" } }, "logType": { "description": "Log record type you want to get. Possible values are either `R` for client requests to an edge server or `F` for forward requests from an edge server to the origin.", "type": "string", "enum": [ "R", "F" ] }, "objectStatus": { "description": "Object status codes you want to get the logs for. To see available values, check [Object status codes](https://techdocs.akamai.com/edge-diagnostics/docs/object-status).", "minLength": 1, "type": "string" }, "start": { "description": "ISO 8601 timestamp for a point of time in the past when the log search window starts. You can get the logs from either the last 6 or 24 hours depending on the server and traffic conditions. The recommended 10-minute periods ensure that data fetches quickly and you get the most relevant logs.", "format": "date-time", "type": "string" } }, "x-akamai": { "file-path": "schemas/grepSyncRequest.yaml" } }, "result": { "additionalProperties": false, "description": "Provides fetched logs.", "type": "object", "required": [ "logs", "legend" ], "properties": { "legend": { "additionalProperties": false, "description": "Descriptions of returned `logType`, `objectStatus`, `objectStatus2`, `objectStatus3` in `r` and `f` log lines.", "type": "object", "required": [ "logType", "rObjectStatus", "rObjectStatus2", "rObjectStatus3", "fObjectStatus", "fObjectStatus2", "fObjectStatus3" ], "properties": { "fObjectStatus": { "description": "Descriptions of the `objectStatus` data in f-line.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } }, "fObjectStatus2": { "description": "Descriptions of the `objectStatus2` data in f-line.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } }, "fObjectStatus3": { "description": "Descriptions of the `objectStatus3` data in f-line.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } }, "logType": { "description": "Description of the `logType` data.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } }, "rObjectStatus": { "description": "Descriptions of the `objectStatus` data in r-line.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } }, "rObjectStatus2": { "description": "Descriptions of the `objectStatus2` data in r-line.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } }, "rObjectStatus3": { "description": "Descriptions of the `objectStatus3` data in r-line.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } } }, "x-akamai": { "file-path": "schemas/legend.yaml" } }, "logs": { "description": "Filtered log lines.", "minItems": 0, "type": "array", "items": { "description": "Items provided as key/value pairs.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } } } }, "x-akamai": { "file-path": "schemas/logsContainer.yaml" } }, "suggestedActions": { "description": "Suggestions on what to do next with the results.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } } }, "x-akamai": { "file-path": "schemas/grepSyncResponse.yaml" } } } }, "headers": { "X-RateLimit-Limit": { "description": "The rate limit ceiling for this endpoint.", "example": 10, "schema": { "type": "integer" }, "x-akamai": { "file-path": "headers/X-RateLimit-Limit.yaml" } }, "X-RateLimit-Remaining": { "description": "The number of requests left for the time window.", "example": 5, "schema": { "type": "integer" }, "x-akamai": { "file-path": "headers/X-RateLimit-Remaining.yaml" } } } }, "400": { "description": "[Validation error](https://techdocs.akamai.com/edge-diagnostics/reference/400).", "content": { "application/problem+json": { "example": { "detail": "Provide only one of these members, either `edgeLocationId` or `edgeIp`.", "status": 400, "title": "Incorrect request.", "type": "bad.request.error", "errors": [ { "requestField": "edgeLocationId", "title": "Conflicting values.", "type": "field.conflict" }, { "requestField": "edgeIp", "title": "Conflicting values.", "type": "field.conflict" } ] }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/400.yaml" } }, "401": { "description": "[Authorization error](https://techdocs.akamai.com/edge-diagnostics/reference/401).", "content": { "application/problem+json": { "example": { "detail": "Inactive client token", "instance": "https://akab-nedrvuylepskzabx-lv3dgceqqktx3i5b.luna.akamaiapis.net/edge-diagnostics/v1/grep/requests", "status": 401, "title": "Not authorized", "type": "https://problems.luna.akamaiapis.net/-/pep-authn/deny" }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/401.yaml" } }, "403": { "description": "[Permission error](https://techdocs.akamai.com/edge-diagnostics/reference/403).", "content": { "application/problem+json": { "example": { "status": 403, "title": "Forbidden request.", "type": "forbidden.request.error", "errors": [ { "detail": "You don't have access to the requested URL. Contact your Admin to request access.", "requestField": "url", "title": "Field access denied.", "type": "field.access.denied" } ] }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/403.yaml" } }, "404": { "description": "[Resource not found error](https://techdocs.akamai.com/edge-diagnostics/reference/404).", "content": { "application/problem+json": { "example": { "detail": "The requested resource couldn't be found. Make sure that the resource is not deleted and the ID is correct.", "status": 404, "title": "Resource not found.", "type": "resource.not.found" }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/404.yaml" } }, "405": { "description": "[Method not allowed](https://techdocs.akamai.com/edge-diagnostics/reference/405).", "content": { "application/problem+json": { "example": { "title": "Method not allowed", "type": "method.not.allowed" }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/405.yaml" } }, "429": { "description": "[Too many requests](https://techdocs.akamai.com/edge-diagnostics/reference/429).", "content": { "application/problem+json": { "example": { "detail": "You have exceeded total number of requests configured for this API.", "status": 429, "title": "Too Many Requests", "type": "requests.exceeded.error" }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/429.yaml" } } }, "parameters": [ { "description": "IP address that belongs to edge server and you want to get the logs for. To verify if an IP address belongs to an edge server, run the [Verify an IP](https://techdocs.akamai.com/edge-diagnostics/reference/post-verify-edge-ip) operation. To get the IP, you may need to run the [Get domain details with dig](https://techdocs.akamai.com/edge-diagnostics/reference/post-dig) or [Get diagnostic data of a group](https://techdocs.akamai.com/edge-diagnostics/reference/get-user-diagnostic-data-group-records) operation first. This is the IP value from the `answerSection` array in the [Get domain details with dig](https://techdocs.akamai.com/edge-diagnostics/reference/post-dig) operation response or the `ip` value from the `edgeIps` array in the [collected diagnostic data](https://techdocs.akamai.com/edge-diagnostics/reference/get-user-diagnostic-data-group-records).", "example": "{{edgeIp}}", "in": "query", "name": "edgeIp", "required": true, "schema": { "example": "192.0.2.192", "type": "string" }, "x-akamai": { "file-path": "parameters/edgeIp-query.yaml" } }, { "description": "CP code you want to get the logs for.", "example": "{{cpCode}}", "in": "query", "name": "cpCode", "required": true, "schema": { "example": 746478, "type": "integer" }, "x-akamai": { "file-path": "parameters/cpCode-query.yaml" } }, { "description": "Client IP to filter the logs by.", "example": "{{clientIp}}", "in": "query", "name": "clientIp", "schema": { "example": "192.0.2.95", "type": "string" }, "x-akamai": { "file-path": "parameters/clientIp-query.yaml" } }, { "description": "Object status codes you want to get the logs for. To see available values, check [Object status codes](https://techdocs.akamai.com/edge-diagnostics/docs/object-status).", "example": "{{objectStatus}}", "in": "query", "name": "objectStatus", "schema": { "example": "pxR", "type": "string" }, "x-akamai": { "file-path": "parameters/objectStatus-query.yaml" } }, { "description": "HTTP status code to filter the logs by.", "example": "{{httpStatusCode}}", "in": "query", "name": "httpStatusCode", "schema": { "example": 200, "type": "integer" }, "x-akamai": { "file-path": "parameters/httpStatusCode-query.yaml" } }, { "description": "User agent to filter the logs by.", "example": "{{userAgent}}", "in": "query", "name": "userAgent", "schema": { "example": "Mozilla/5.0", "type": "string" }, "x-akamai": { "file-path": "parameters/userAgent-query.yaml" } }, { "description": "[ARL](https://techdocs.akamai.com/edge-diagnostics/docs/arl-syntax) to filter the logs by.", "example": "{{arl}}", "in": "query", "name": "arl", "schema": { "example": "/=/1234/12345/1d/ts.download.akamai.com/eum/results.txt", "type": "string" }, "x-akamai": { "file-path": "parameters/arl-query.yaml" } }, { "description": "ISO 8601 timestamp for a point of time in the past when the log search window starts. You can get the logs from either the last 6 or 24 hours depending on the server and traffic conditions. The recommended 10-minute periods ensure that data fetches quickly and you get the most relevant logs.", "example": "{{start}}", "in": "query", "name": "start", "schema": { "example": "2022-03-15T06:08:40Z", "type": "string" }, "x-akamai": { "file-path": "parameters/start-query.yaml" } }, { "description": "ISO 8601 timestamp for a point of time in the past when the log search window ends.", "example": "{{end}}", "in": "query", "name": "end", "schema": { "example": "2022-03-15T06:08:43Z", "type": "string" }, "x-akamai": { "file-path": "parameters/end-query.yaml" } }, { "description": "__Enum__ Record type of the logs. Possible values are either `R` for client requests to an edge server or `F` for forward requests from an edge server to the origin.", "example": "{{logType}}", "in": "query", "name": "logType", "schema": { "example": "R", "type": "string", "enum": [ "R", "F" ] }, "x-akamai": { "file-path": "parameters/logType-query.yaml" } }, { "description": "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ] } }, "/grep/requests/{requestId}": { "get": { "description": "Returns the status of the [asynchronous](https://techdocs.akamai.com/edge-diagnostics/reference/asynchronous-processes) [Launch a GREP request](https://techdocs.akamai.com/edge-diagnostics/reference/post-grep) request. Operations with the `SUCCESS` status include also the `grep` logs.", "operationId": "get-grep-request", "summary": "Check a GREP request status", "tags": [ "Grep" ], "externalDocs": { "description": "See documentation for this operation in Akamai's Edge Diagnostics API", "url": "https://techdocs.akamai.com/edge-diagnostics/reference/get-grep-request" }, "responses": { "200": { "description": "The response provides the status of the request and its details.", "content": { "application/json": { "example": { "completedTime": "2021-04-15T07:49:15Z", "createdBy": "tyamada", "createdTime": "2021-04-15T07:48:30Z", "executionStatus": "SUCCESS", "logLinesCount": 2, "requestId": 365, "suggestedActions": [ "Check for long times.", "Check content length/bytes served." ], "edgeIpLocation": { "asNumber": 9498, "city": "BANGALORE", "countryCode": "IN", "regionCode": "KA" }, "request": { "edgeIp": "192.0.2.0", "end": "2022-03-15T06:08:43.000Z", "logType": "BOTH", "start": "2022-03-15T06:08:40.000Z", "clientIps": [ "192.0.2.9" ], "cpCodes": [ 1234567 ], "userAgents": [ "firefox" ], "arls": { "comparison": "CONTAINS", "value": [ "freeflow.mdt.akamai.com/TopLevel.incr.idx" ] }, "httpStatusCodes": { "comparison": "EQUALS", "value": [ "200", "201" ] } }, "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": "-" } ] } }, "schema": { "additionalProperties": false, "description": "Collects the `grep` response and details about the request.", "type": "object", "required": [ "request", "requestId", "executionStatus", "createdBy", "createdTime" ], "properties": { "completedTime": { "description": "ISO 8601 timestamp indicating when the request was completed.", "format": "date-time", "type": "string" }, "createdBy": { "description": "Username who submitted the request.", "minLength": 1, "type": "string" }, "createdTime": { "description": "ISO 8601 timestamp indicating when the request was submitted.", "format": "date-time", "type": "string" }, "edgeIpLocation": { "additionalProperties": false, "description": "Lists geolocation data of the edge IP used to get the data.", "type": "object", "required": [ "city", "regionCode", "countryCode", "asNumber" ], "properties": { "asNumber": { "description": "Autonomous System Number the edge IP maps to.", "minimum": 0, "type": "integer" }, "city": { "description": "Closest city within a 50-mile radius the edge IP maps to.", "minLength": 1, "type": "string" }, "countryCode": { "description": "ISO 3166 country code the edge IP maps to.", "minLength": 1, "type": "string" }, "regionCode": { "description": "ISO 3166 region code the edge IP maps to.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/edgeIpLocation.yaml" } }, "errorResponse": { "additionalProperties": false, "description": "Specifies the reason for `FAILURE` status.", "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Details about the error.", "minLength": 1, "type": "string" }, "errors": { "description": "Collects information about problems occurred while fetching the data.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } }, "status": { "description": "Error status code.", "minLength": 1, "type": "string" }, "title": { "description": "Error title.", "minLength": 1, "type": "string" }, "type": { "description": "Error type.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/errorResponse.yaml" } }, "executionStatus": { "description": "Status of the request's execution. For the POST operation, possible options are `SUCCESS`, `FAILURE`, or `PARTIAL_SUCCESS`. Check the `warning` array, to learn about the reasons behind `PARTIAL_SUCCESS` and `errorResponse` for `FAILURE` reason. For the GET operation, possible values are either `SUCCESS` or `FAILURE`.", "type": "string", "enum": [ "SUCCESS", "FAILURE", "PARTIAL_SUCCESS" ] }, "link": { "description": "Link to GET fetched GREP data after the `retryAfter` interval passes. It occurs only for operations with the `IN_PROGRESS` status.", "minLength": 1, "type": "string" }, "logLinesCount": { "description": "Number of fetched logs.", "minimum": 0, "type": "integer" }, "request": { "additionalProperties": false, "description": "Specifies your asynchronous `grep` request.", "type": "object", "required": [ "edgeIp", "logType", "start", "end" ], "properties": { "arls": { "additionalProperties": false, "description": "Collects ARLs to filter the logs by.", "type": "object", "required": [ "comparison", "value" ], "properties": { "comparison": { "description": "Comparison filter type. Possible values are either `CONTAINS` if you want to get the logs for specific `value` or `NOT_CONTAINS` if you want to exclude specific `value` from logs.", "type": "string", "enum": [ "CONTAINS", "NOT_CONTAINS" ] }, "value": { "description": "Lists ARLs to filter the logs by in relation to the `comparison` value.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } } }, "x-akamai": { "file-path": "schemas/arls.yaml" } }, "clientIps": { "description": "Lists client IPs to filter the logs by.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } }, "cpCodes": { "description": "Lists CP codes you want to get the logs for. You need to provide either this value or `hostnames`.", "minItems": 0, "type": "array", "items": { "minimum": 0, "type": "integer" } }, "edgeIp": { "description": "Edge IP you want to get the logs for. If you don't know if an IP is the edge IP, run the [Verify an IP](https://techdocs.akamai.com/edge-diagnostics/reference/post-verify-edge-ip) operation first. You can use the edge server IP value from the `answerSection` array in the [Get domain details with dig](https://techdocs.akamai.com/edge-diagnostics/reference/post-dig) operation response or the `ip` value from the `edgeIps` array in the [collected diagnostic data](https://techdocs.akamai.com/edge-diagnostics/reference/get-user-diagnostic-data-group-records).", "minLength": 1, "type": "string" }, "end": { "description": "ISO 8601 timestamp for a point of time in the past when the log search window ends.", "format": "date-time", "type": "string" }, "hostnames": { "description": "Lists hostnames you want to get the logs for. You need to provide either this value or `cpCodes`.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } }, "httpStatusCodes": { "additionalProperties": false, "description": "Filters the logs by specific HTTP status codes.", "type": "object", "required": [ "comparison", "value" ], "properties": { "comparison": { "description": "Comparison filter type. Possible values are either `EQUALS` if you want to get the logs for specific `value` or `NOT_EQUALS` if you want to exclude specific `value` from logs.", "type": "string", "enum": [ "EQUALS", "NOT_EQUALS" ] }, "value": { "description": "Lists HTTP status codes to filter the logs by in relation to the `comparison` value.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } } }, "x-akamai": { "file-path": "schemas/httpStatusCodes.yaml" } }, "logType": { "description": "Log record type you want to get. Possible values are: `R` for client requests to an edge server, `F` for forward requests from an edge server to the origin, or `BOTH`.", "type": "string", "enum": [ "R", "F", "BOTH" ] }, "start": { "description": "ISO 8601 timestamp for a point of time in the past when the log search window starts. You can get the logs from either the last 6 or 24 hours depending on the server and traffic conditions. The recommended 10-minute periods ensure that data fetches quickly and you get the most relevant logs.", "format": "date-time", "type": "string" }, "userAgents": { "description": "Lists user agents to filter the logs by.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } } }, "x-akamai": { "file-path": "schemas/grepRequest.yaml" } }, "requestId": { "description": "Unique identifier for the `grep` request. Store this value to run [Check a GREP request status](https://techdocs.akamai.com/edge-diagnostics/reference/get-grep-request) operation.", "minimum": 0, "type": "integer" }, "result": { "additionalProperties": false, "description": "Collects fetched logs.", "type": "object", "required": [ "logs", "legend" ], "properties": { "legend": { "additionalProperties": false, "description": "Descriptions of returned `logType`, `objectStatus`, `objectStatus2`, `objectStatus3` in `r` and `f` log lines.", "type": "object", "required": [ "logType", "rObjectStatus", "rObjectStatus2", "rObjectStatus3", "fObjectStatus", "fObjectStatus2", "fObjectStatus3" ], "properties": { "fObjectStatus": { "description": "Descriptions of the `objectStatus` data in f-line.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } }, "fObjectStatus2": { "description": "Descriptions of the `objectStatus2` data in f-line.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } }, "fObjectStatus3": { "description": "Descriptions of the `objectStatus3` data in f-line.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } }, "logType": { "description": "Description of the `logType` data.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } }, "rObjectStatus": { "description": "Descriptions of the `objectStatus` data in r-line.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } }, "rObjectStatus2": { "description": "Descriptions of the `objectStatus2` data in r-line.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } }, "rObjectStatus3": { "description": "Descriptions of the `objectStatus3` data in r-line.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } } }, "x-akamai": { "file-path": "schemas/legend.yaml" } }, "logs": { "description": "Filtered log lines.", "minItems": 0, "type": "array", "items": { "description": "Items provided as key/value pairs.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } } } }, "x-akamai": { "file-path": "schemas/logsContainer.yaml" } }, "retryAfter": { "description": "Number of seconds when the request is estimated to have processed. It occurs only for operations with the `IN_PROGRESS` status.", "minimum": 0, "type": "integer" }, "suggestedActions": { "description": "Suggestions on what to do next with the results.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } }, "warning": { "additionalProperties": false, "description": "Reasons why `executionStatus` is `PARTIAL_SUCCESS`.", "type": "object", "required": [ "key", "message" ], "properties": { "key": { "description": "Unique key representing the warning message.", "minLength": 1, "type": "string" }, "message": { "description": "Warning message for the `grep` request.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/warning.yaml" } } }, "x-akamai": { "file-path": "schemas/grepResponse.yaml" } } } }, "headers": { "X-RateLimit-Limit": { "description": "The rate limit ceiling for this endpoint.", "example": 10, "schema": { "type": "integer" }, "x-akamai": { "file-path": "headers/X-RateLimit-Limit.yaml" } }, "X-RateLimit-Remaining": { "description": "The number of requests left for the time window.", "example": 5, "schema": { "type": "integer" }, "x-akamai": { "file-path": "headers/X-RateLimit-Remaining.yaml" } } } }, "401": { "description": "[Authorization error](https://techdocs.akamai.com/edge-diagnostics/reference/401).", "content": { "application/problem+json": { "example": { "detail": "Inactive client token", "instance": "https://akab-nedrvuylepskzabx-lv3dgceqqktx3i5b.luna.akamaiapis.net/edge-diagnostics/v1/grep/requests", "status": 401, "title": "Not authorized", "type": "https://problems.luna.akamaiapis.net/-/pep-authn/deny" }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/401.yaml" } }, "404": { "description": "[Resource not found error](https://techdocs.akamai.com/edge-diagnostics/reference/404).", "content": { "application/problem+json": { "example": { "detail": "The requested resource couldn't be found. Make sure that the resource is not deleted and the ID is correct.", "status": 404, "title": "Resource not found.", "type": "resource.not.found" }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/404.yaml" } }, "405": { "description": "[Method not allowed](https://techdocs.akamai.com/edge-diagnostics/reference/405).", "content": { "application/problem+json": { "example": { "title": "Method not allowed", "type": "method.not.allowed" }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/405.yaml" } }, "429": { "description": "[Too many requests](https://techdocs.akamai.com/edge-diagnostics/reference/429).", "content": { "application/problem+json": { "example": { "detail": "You have exceeded total number of requests configured for this API.", "status": 429, "title": "Too Many Requests", "type": "requests.exceeded.error" }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/429.yaml" } } }, "parameters": [ { "description": "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ] }, "parameters": [ { "description": "Unique identifier for a request. To get this value, run the corresponding POST operation.", "example": "{{requestId}}", "in": "path", "name": "requestId", "required": true, "schema": { "example": 365, "type": "integer" }, "x-akamai": { "file-path": "parameters/requestId-path.yaml" } } ] }, "/gtm/gtm-properties": { "get": { "description": "Lists GTM properties you have access to. You can use the returned `hostname` values to run [Test network connectivity with MTR](https://techdocs.akamai.com/edge-diagnostics/reference/post-mtr) and [Get domain details with dig](https://techdocs.akamai.com/edge-diagnostics/reference/post-dig) operations for a GTM hostname. Note, that the [Test network connectivity with MTR](https://techdocs.akamai.com/edge-diagnostics/reference/post-mtr) operation requires also hostname's test and target IP values, that you can get with the [List test and target IPs for a GTM hostname](https://techdocs.akamai.com/edge-diagnostics/reference/get-gtm-property-domain-gtm-property-ips) operation.", "operationId": "get-gtm-properties", "summary": "List GTM properties", "tags": [ "GTM properties" ], "externalDocs": { "description": "See documentation for this operation in Akamai's Edge Diagnostics API", "url": "https://techdocs.akamai.com/edge-diagnostics/reference/get-gtm-properties" }, "responses": { "200": { "description": "The response lists available GTM properties.", "content": { "application/json": { "example": { "gtmProperties": [ { "domain": "akadns.net", "hostname": "origin.example.net", "property": "origin" }, { "domain": "akadns.net", "hostname": "origin-r3h.akadns.net", "property": "origin-r3h" } ] }, "schema": { "additionalProperties": false, "description": "Collects all GTM properties you have access to within a top-level `gtmProperties` array.", "type": "object", "required": [ "gtmProperties" ], "properties": { "gtmProperties": { "description": "Lists GTM properties and their details.", "minItems": 0, "type": "array", "items": { "additionalProperties": false, "description": "Specifies a GTM property.", "type": "object", "required": [ "property", "domain", "hostname" ], "properties": { "domain": { "description": "Domain name.", "minLength": 1, "type": "string" }, "hostname": { "description": "Complete hostname.", "format": "hostname", "type": "string" }, "property": { "description": "Subdomain property.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/gtmProperty.yaml" } } } }, "x-akamai": { "file-path": "schemas/gtmPropertiesResponse.yaml" } } } }, "headers": { "X-RateLimit-Limit": { "description": "The rate limit ceiling for this endpoint.", "example": 10, "schema": { "type": "integer" }, "x-akamai": { "file-path": "headers/X-RateLimit-Limit.yaml" } }, "X-RateLimit-Remaining": { "description": "The number of requests left for the time window.", "example": 5, "schema": { "type": "integer" }, "x-akamai": { "file-path": "headers/X-RateLimit-Remaining.yaml" } } } }, "401": { "description": "[Authorization error](https://techdocs.akamai.com/edge-diagnostics/reference/401).", "content": { "application/problem+json": { "example": { "detail": "Inactive client token", "instance": "https://akab-nedrvuylepskzabx-lv3dgceqqktx3i5b.luna.akamaiapis.net/edge-diagnostics/v1/grep/requests", "status": 401, "title": "Not authorized", "type": "https://problems.luna.akamaiapis.net/-/pep-authn/deny" }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/401.yaml" } }, "405": { "description": "[Method not allowed](https://techdocs.akamai.com/edge-diagnostics/reference/405).", "content": { "application/problem+json": { "example": { "title": "Method not allowed", "type": "method.not.allowed" }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/405.yaml" } }, "429": { "description": "[Too many requests](https://techdocs.akamai.com/edge-diagnostics/reference/429).", "content": { "application/problem+json": { "example": { "detail": "You have exceeded total number of requests configured for this API.", "status": 429, "title": "Too Many Requests", "type": "requests.exceeded.error" }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/429.yaml" } } }, "parameters": [ { "description": "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ] } }, "/gtm/{property}/{domain}/gtm-property-ips": { "get": { "description": "Lists test and target IPs for a GTM property. You can use the returned data to run the [Test network connectivity with MTR](https://techdocs.akamai.com/edge-diagnostics/reference/post-mtr) operation for a GTM hostname. To get the data necessary for this request, run the [List GTM properties](https://techdocs.akamai.com/edge-diagnostics/reference/get-gtm-properties) operation first.", "operationId": "get-gtm-property-domain-gtm-property-ips", "summary": "List test and target IPs for a GTM hostname", "tags": [ "GTM properties" ], "externalDocs": { "description": "See documentation for this operation in Akamai's Edge Diagnostics API", "url": "https://techdocs.akamai.com/edge-diagnostics/reference/get-gtm-property-domain-gtm-property-ips" }, "responses": { "200": { "description": "The response lists available test and target IPs.", "content": { "application/json": { "example": { "gtmPropertyIps": { "domain": "akamai.akadns.net", "property": "www-origin", "targets": [ "192.0.2.17" ], "testIps": [ "192.0.2.13" ] } }, "schema": { "additionalProperties": false, "description": "Collects test and target IPs of a GTM property within the top-level object's `gtmPropertyIps` member.", "type": "object", "required": [ "gtmPropertyIps" ], "properties": { "gtmPropertyIps": { "additionalProperties": false, "description": "Specifies your GTM property.", "type": "object", "required": [ "property", "domain", "testIps", "targets" ], "properties": { "domain": { "description": "Domain of the GTM property.", "minLength": 1, "type": "string" }, "property": { "description": "GTM property of interest.", "minLength": 1, "type": "string" }, "targets": { "description": "Lists Target IPs of the GTM property.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } }, "testIps": { "description": "Lists Test IPs of the GTM property.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } } }, "x-akamai": { "file-path": "schemas/gtmPropertyIps.yaml" } } }, "x-akamai": { "file-path": "schemas/gtmPropertiesIpsResponse.yaml" } } } }, "headers": { "X-RateLimit-Limit": { "description": "The rate limit ceiling for this endpoint.", "example": 10, "schema": { "type": "integer" }, "x-akamai": { "file-path": "headers/X-RateLimit-Limit.yaml" } }, "X-RateLimit-Remaining": { "description": "The number of requests left for the time window.", "example": 5, "schema": { "type": "integer" }, "x-akamai": { "file-path": "headers/X-RateLimit-Remaining.yaml" } } } }, "401": { "description": "[Authorization error](https://techdocs.akamai.com/edge-diagnostics/reference/401).", "content": { "application/problem+json": { "example": { "detail": "Inactive client token", "instance": "https://akab-nedrvuylepskzabx-lv3dgceqqktx3i5b.luna.akamaiapis.net/edge-diagnostics/v1/grep/requests", "status": 401, "title": "Not authorized", "type": "https://problems.luna.akamaiapis.net/-/pep-authn/deny" }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/401.yaml" } }, "405": { "description": "[Method not allowed](https://techdocs.akamai.com/edge-diagnostics/reference/405).", "content": { "application/problem+json": { "example": { "title": "Method not allowed", "type": "method.not.allowed" }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/405.yaml" } }, "429": { "description": "[Too many requests](https://techdocs.akamai.com/edge-diagnostics/reference/429).", "content": { "application/problem+json": { "example": { "detail": "You have exceeded total number of requests configured for this API.", "status": 429, "title": "Too Many Requests", "type": "requests.exceeded.error" }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/429.yaml" } } }, "parameters": [ { "description": "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ] }, "parameters": [ { "description": "Name of the GTM property. To get this value, run the [List GTM properties](https://techdocs.akamai.com/edge-diagnostics/reference/get-gtm-properties) operation.", "example": "{{property}}", "in": "path", "name": "property", "required": true, "schema": { "example": "www-origin", "type": "string" }, "x-akamai": { "file-path": "parameters/property-path.yaml" } }, { "description": "Domain of the GTM property. To get this value, run the [List GTM properties](https://techdocs.akamai.com/edge-diagnostics/reference/get-gtm-properties) operation.", "example": "{{domain}}", "in": "path", "name": "domain", "required": true, "schema": { "example": "akamai.akadns.net", "type": "string" }, "x-akamai": { "file-path": "parameters/domain-path.yaml" } } ] }, "/ipa/hostnames": { "get": { "description": "Lists IP acceleration (IPA) hostnames you have access to and can [generate a diagnostic link](https://techdocs.akamai.com/edge-diagnostics/reference/post-user-diagnostic-data-groups) to collect diagnostic data.", "operationId": "get-ipa-hostnames", "summary": "List IP acceleration hostnames", "tags": [ "IPA hostnames" ], "externalDocs": { "description": "See documentation for this operation in Akamai's Edge Diagnostics API", "url": "https://techdocs.akamai.com/edge-diagnostics/reference/get-ipa-hostnames" }, "responses": { "200": { "description": "The response lists available IPA hostnames.", "content": { "application/json": { "example": { "hostnames": [ "example.com" ] }, "schema": { "additionalProperties": false, "description": "Lists available IPA hostnames.", "type": "object", "required": [ "hostnames" ], "properties": { "hostnames": { "description": "Lists available IPA hostnames.", "minItems": 0, "type": "array", "items": { "format": "hostname", "type": "string" } } }, "x-akamai": { "file-path": "schemas/ipaHostnames.yaml" } } } }, "headers": { "X-RateLimit-Limit": { "description": "The rate limit ceiling for this endpoint.", "example": 10, "schema": { "type": "integer" }, "x-akamai": { "file-path": "headers/X-RateLimit-Limit.yaml" } }, "X-RateLimit-Remaining": { "description": "The number of requests left for the time window.", "example": 5, "schema": { "type": "integer" }, "x-akamai": { "file-path": "headers/X-RateLimit-Remaining.yaml" } } } }, "401": { "description": "[Authorization error](https://techdocs.akamai.com/edge-diagnostics/reference/401).", "content": { "application/problem+json": { "example": { "detail": "Inactive client token", "instance": "https://akab-nedrvuylepskzabx-lv3dgceqqktx3i5b.luna.akamaiapis.net/edge-diagnostics/v1/grep/requests", "status": 401, "title": "Not authorized", "type": "https://problems.luna.akamaiapis.net/-/pep-authn/deny" }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/401.yaml" } }, "405": { "description": "[Method not allowed](https://techdocs.akamai.com/edge-diagnostics/reference/405).", "content": { "application/problem+json": { "example": { "title": "Method not allowed", "type": "method.not.allowed" }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/405.yaml" } }, "429": { "description": "[Too many requests](https://techdocs.akamai.com/edge-diagnostics/reference/429).", "content": { "application/problem+json": { "example": { "detail": "You have exceeded total number of requests configured for this API.", "status": 429, "title": "Too Many Requests", "type": "requests.exceeded.error" }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/429.yaml" } } }, "parameters": [ { "description": "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ] } }, "/locate-ip": { "post": { "description": "Returns geolocation data of an IP's network. You can enter up to 10 IPs.", "operationId": "post-locate-ip", "summary": "Locate an IP network", "tags": [ "IP network location" ], "externalDocs": { "description": "See documentation for this operation in Akamai's Edge Diagnostics API", "url": "https://techdocs.akamai.com/edge-diagnostics/reference/post-locate-ip" }, "requestBody": { "required": true, "content": { "application/json": { "example": { "ipAddresses": [ "192.0.2.9", "192.0.2.0" ] }, "schema": { "additionalProperties": false, "description": "Specifies IP addresses you want to [verify](https://techdocs.akamai.com/edge-diagnostics/reference/post-verify-edge-ip) or get the [location data](https://techdocs.akamai.com/edge-diagnostics/reference/post-locate-ip) for.", "type": "object", "required": [ "ipAddresses" ], "properties": { "ipAddresses": { "description": "Up to 10 IP addresses you want to get the data for.", "maxItems": 10, "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } } }, "x-akamai": { "file-path": "schemas/verifyLocateIpsRequest.yaml" } } } } }, "responses": { "200": { "description": "The response provides location data for the IP's network.", "content": { "application/json": { "example": { "completedTime": "2022-02-01T17:40:32Z", "createdBy": "jkowalski", "createdTime": "2022-02-01T17:40:29Z", "executionStatus": "SUCCESS", "request": { "ipAddresses": [ "192.0.2.9", "192.0.2.0" ] }, "results": [ { "executionStatus": "SUCCESS", "ipAddress": "192.0.2.9", "geoLocation": { "asNumber": 13335, "city": "SYDNEY", "continent": "OC", "countryCode": "AU", "latitude": -33.88, "longitude": 151.22, "network": "mil", "regionCode": "NSW", "throughput": "low", "timeZone": "GMT+10" } }, { "executionStatus": "SUCCESS", "ipAddress": "192.0.2.0", "geoLocation": { "city": "SEOUL", "continent": "AS", "countryCode": "KR", "latitude": 37.57, "longitude": 127, "throughput": "low", "timeZone": "GMT+9" } } ] }, "schema": { "additionalProperties": false, "description": "Collects information about the IP's network location and details about the request.", "type": "object", "required": [ "request", "createdBy", "createdTime", "executionStatus", "results" ], "properties": { "completedTime": { "description": "ISO 8601 timestamp indicating when the request was completed.", "format": "date-time", "type": "string" }, "createdBy": { "description": "Username who submitted the request.", "minLength": 1, "type": "string" }, "createdTime": { "description": "ISO 8601 timestamp indicating when the request was submitted.", "format": "date-time", "type": "string" }, "executionStatus": { "description": "Status of the request's execution. Possible values are: `SUCCESS`, `FAILURE`, or `PARTIAL_SUCCESS`. `PARTIAL_SUCCESS` is for bulk requests, if some of the requested IPs couldn't be processed.", "type": "string", "enum": [ "SUCCESS", "FAILURE", "PARTIAL_SUCCESS" ] }, "request": { "additionalProperties": false, "description": "IP addresses you want to get the data for.", "type": "object", "required": [ "ipAddresses" ], "properties": { "ipAddresses": { "description": "Up to 10 IP addresses you want to get the data for.", "maxItems": 10, "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } } }, "x-akamai": { "file-path": "schemas/verifyLocateIpsRequest.yaml" } }, "results": { "description": "Lists results for requested IPs.", "minItems": 0, "type": "array", "items": { "additionalProperties": false, "description": "Collects information about the IP's network location and details about the request.", "type": "object", "required": [ "executionStatus", "ipAddress", "geoLocation" ], "properties": { "executionStatus": { "description": "Status of the execution, either `SUCCESS` or `FAILURE`.", "type": "string", "enum": [ "SUCCESS", "FAILURE" ] }, "geoLocation": { "additionalProperties": false, "description": "Specifies the IP's network location. To learn more about the results, check [Verify and Locate IP results](https://techdocs.akamai.com/edge-diagnostics/docs/verify-locate-ip#results).", "type": "object", "properties": { "areaCode": { "description": "List of comma-delimited area codes the IP's network maps to.", "minLength": 1, "type": "string" }, "asNumber": { "description": "Autonomous System Number the IP's network maps to.", "minimum": 0, "type": "integer" }, "city": { "description": "Closest city within a 50-mile radius the IP's network maps to.", "minLength": 1, "type": "string" }, "continent": { "description": "ISO 3166 continent code the IP's network maps to.", "minLength": 1, "type": "string" }, "countryCode": { "description": "ISO 3166 country code the IP's network maps to.", "minLength": 1, "type": "string" }, "county": { "description": "Counties the IP's network maps to. Multiple values are separated with `+`.", "minLength": 0, "type": "string" }, "dma": { "description": "Designated Market Area code the IP's network maps to.", "minimum": 0, "type": "integer" }, "fips": { "description": "Federal Information Processing Standards code the IP's network maps to.", "minLength": 1, "type": "string" }, "latitude": { "description": "The latitude the IP's network maps to.", "maximum": 90, "minimum": -90, "type": "number" }, "longitude": { "description": "The longitude the IP's network maps to.", "maximum": 180, "minimum": -180, "type": "number" }, "msa": { "description": "Metropolitan Statistical Area code the IP's network maps to.", "minimum": 0, "type": "integer" }, "network": { "description": "Network the IP maps to. The value may be `null` when edge servers lack that data.", "minLength": 1, "nullable": true, "type": "string" }, "networkType": { "description": "Network type the IP maps to. The value may be `null` when edge servers lack that data.", "minLength": 1, "nullable": true, "type": "string" }, "pmsa": { "description": "Primary Metropolitan Statistical Area code the IP's network maps to.", "minimum": 0, "type": "integer" }, "proxy": { "description": "Proxy the IP maps to. The value may be `null` when the IP address is not a proxy.", "minLength": 1, "nullable": true, "type": "string" }, "regionCode": { "description": "ISO 3166 region code the IP's network maps to.", "minLength": 1, "type": "string" }, "throughput": { "description": "Connection speed of the IP's network. Possible values are `low`, `medium`, `high`, or `vhigh`. IPv6 traffic is always `low`.", "type": "string", "enum": [ "low", "medium", "high", "vhigh" ] }, "timeZone": { "description": "Time zone used by the IP's network.", "minLength": 1, "type": "string" }, "zipCode": { "description": "Zip code the IP's network maps to. Multiple values are separated with `+` and ranges are separated with `-`.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/geoLocation.yaml" } }, "ipAddress": { "description": "IP address of the request.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/locateIpData.yaml" } } } }, "x-akamai": { "file-path": "schemas/locateIp.yaml" } } } }, "headers": { "X-RateLimit-Limit": { "description": "The rate limit ceiling for this endpoint.", "example": 10, "schema": { "type": "integer" }, "x-akamai": { "file-path": "headers/X-RateLimit-Limit.yaml" } }, "X-RateLimit-Remaining": { "description": "The number of requests left for the time window.", "example": 5, "schema": { "type": "integer" }, "x-akamai": { "file-path": "headers/X-RateLimit-Remaining.yaml" } } } }, "400": { "description": "[Validation error](https://techdocs.akamai.com/edge-diagnostics/reference/400).", "content": { "application/problem+json": { "example": { "detail": "Provide only one of these members, either `edgeLocationId` or `edgeIp`.", "status": 400, "title": "Incorrect request.", "type": "bad.request.error", "errors": [ { "requestField": "edgeLocationId", "title": "Conflicting values.", "type": "field.conflict" }, { "requestField": "edgeIp", "title": "Conflicting values.", "type": "field.conflict" } ] }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/400.yaml" } }, "401": { "description": "[Authorization error](https://techdocs.akamai.com/edge-diagnostics/reference/401).", "content": { "application/problem+json": { "example": { "detail": "Inactive client token", "instance": "https://akab-nedrvuylepskzabx-lv3dgceqqktx3i5b.luna.akamaiapis.net/edge-diagnostics/v1/grep/requests", "status": 401, "title": "Not authorized", "type": "https://problems.luna.akamaiapis.net/-/pep-authn/deny" }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/401.yaml" } }, "403": { "description": "[Permission error](https://techdocs.akamai.com/edge-diagnostics/reference/403).", "content": { "application/problem+json": { "example": { "status": 403, "title": "Forbidden request.", "type": "forbidden.request.error", "errors": [ { "detail": "You don't have access to the requested URL. Contact your Admin to request access.", "requestField": "url", "title": "Field access denied.", "type": "field.access.denied" } ] }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/403.yaml" } }, "405": { "description": "[Method not allowed](https://techdocs.akamai.com/edge-diagnostics/reference/405).", "content": { "application/problem+json": { "example": { "title": "Method not allowed", "type": "method.not.allowed" }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/405.yaml" } }, "429": { "description": "[Too many requests](https://techdocs.akamai.com/edge-diagnostics/reference/429).", "content": { "application/problem+json": { "example": { "detail": "You have exceeded total number of requests configured for this API.", "status": 429, "title": "Too Many Requests", "type": "requests.exceeded.error" }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/429.yaml" } } }, "parameters": [ { "description": "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ] } }, "/metadata-tracer": { "post": { "description": "Launches an [asynchronous](https://techdocs.akamai.com/edge-diagnostics/reference/asynchronous-processes) request to trace metadata for a URL configured in Property Manager. The metadata tracing works for the current property version active either on staging or production. To run the operation for a location, run the [List available locations for metadata tracing](https://techdocs.akamai.com/edge-diagnostics/reference/get-mdt-locations) operation first to get available values. If you don't provide a location ID or an edge server IP, then Edge Diagnostics runs the operation using a random location. ", "operationId": "post-mdt", "summary": "Launch a metadata tracing request", "tags": [ "Metadata Tracer" ], "externalDocs": { "description": "See documentation for this operation in Akamai's Edge Diagnostics API", "url": "https://techdocs.akamai.com/edge-diagnostics/reference/post-mdt" }, "requestBody": { "required": true, "content": { "application/json": { "example": { "edgeIp": "192.0.2.12", "url": "https://www.example.com", "requestHeaders": [ "Connection: keep-alive", "Accept-Language: en-US" ] }, "schema": { "additionalProperties": false, "description": "Collects data to use in the metadata tracer request.", "type": "object", "required": [ "url" ], "properties": { "edgeIp": { "description": "IP of the edge server you want to run the operation from. If you don't know if an IP is the edge IP, run the [Verify an IP](https://techdocs.akamai.com/edge-diagnostics/reference/post-verify-edge-ip) operation. Provide either this value or `mdtLocationId`.", "example": "{{edgeIp}}", "minLength": 1, "type": "string" }, "httpBody": { "description": "The POST call's request body.", "example": "{{httpBody}}", "maxLength": 4096, "minLength": 1, "type": "string" }, "httpMethod": { "default": "GET", "description": "HTTP method you want to use to run the operation, either `HEAD`, `POST`, or the default `GET` method.", "example": "{{httpMethod}}", "type": "string", "enum": [ "HEAD", "GET", "POST" ] }, "mdtLocationId": { "description": "Unique identifier for an available location closest to your end users. To get this value, run the [List available locations for metadata tracing](https://techdocs.akamai.com/edge-diagnostics/reference/get-mdt-locations) operation first. For `GET` and `HEAD`, provide either this value or `edgeIp`.", "example": "{{mdtLocationId}}", "minLength": 1, "type": "string" }, "requestHeaders": { "description": "Customized headers for metadata tracer request in the format `header: value`. Check [Pragma headers](https://techdocs.akamai.com/edge-diagnostics/docs/pragma-headers) for the list of Akamized Pragma headers you can use here.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } }, "sensitiveRequestHeaderKeys": { "description": "Sensitive `requestHeaders` you don't want to store in the database after running the request. Check [Sensitive headers](https://techdocs.akamai.com/edge-diagnostics/reference/sensitive-headers) to see the list of request headers treated as sensitive by default.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } }, "url": { "description": "URL configured in Property Manager you want to get the metadata trace for.", "example": "{{url}}", "format": "uri", "type": "string" }, "useStaging": { "description": "Runs the request on the staging environment, `false` by default. ", "example": "{{useStaging}}", "type": "boolean" } }, "x-akamai": { "file-path": "schemas/mdtRequest.yaml" } } } } }, "responses": { "202": { "description": "Process successfully launched.", "content": { "application/json": { "example": { "createdBy": "hgildong", "createdTime": "2021-04-20T08:50:34Z", "executionStatus": "IN_PROGRESS", "link": "/edge-diagnostics/v1/metadata-tracer/requests/241", "requestId": 241, "retryAfter": 3, "request": { "edgeIp": "192.0.2.12", "url": "https://www.example.com", "requestHeaders": [ "Connection: keep-alive", "Accept-Language: en-US" ] } }, "schema": { "additionalProperties": false, "description": "Collects the metadata tracer response and details about the request.", "type": "object", "required": [ "requestId", "executionStatus", "createdBy", "createdTime", "request" ], "properties": { "completedTime": { "description": "ISO 8601 timestamp indicating when the request was completed.", "format": "date-time", "type": "string" }, "createdBy": { "description": "Username who submitted the request.", "minLength": 1, "type": "string" }, "createdTime": { "description": "ISO 8601 timestamp indicating when the request was submitted.", "format": "date-time", "type": "string" }, "edgeIpLocation": { "additionalProperties": false, "description": "Specifies the geolocation of the edge server used to run the operation.", "type": "object", "required": [ "city", "regionCode", "countryCode", "asNumber" ], "properties": { "asNumber": { "description": "Autonomous System Number the edge IP maps to.", "minimum": 0, "type": "integer" }, "city": { "description": "Closest city within a 50-mile radius the edge IP maps to.", "minLength": 1, "type": "string" }, "countryCode": { "description": "ISO 3166 country code the edge IP maps to.", "minLength": 1, "type": "string" }, "regionCode": { "description": "ISO 3166 region code the edge IP maps to.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/edgeIpLocation.yaml" } }, "executionStatus": { "description": "Status of the request's execution. Possible values are `SUCCESS`, `FAILURE`, or `IN_PROGRESS`.", "type": "string", "enum": [ "SUCCESS", "FAILURE", "IN_PROGRESS" ] }, "internalIp": { "description": "If your request contained `edgeLocationId` then this is the IP of a machine in that location. If you run the operation for a virtual IP, then this is the IP of a machine behind that virtual IP.", "minLength": 1, "type": "string" }, "link": { "description": "Link to get fetched metadata tracer response after the `retryAfter` interval passes. It occurs only for operations with the `IN_PROGRESS` status.", "minLength": 1, "type": "string" }, "request": { "additionalProperties": false, "description": "Specifies your request.", "type": "object", "required": [ "url" ], "properties": { "edgeIp": { "description": "IP of the edge server you want to run the operation from. If you don't know if an IP is the edge IP, run the [Verify an IP](https://techdocs.akamai.com/edge-diagnostics/reference/post-verify-edge-ip) operation. Provide either this value or `mdtLocationId`.", "minLength": 1, "type": "string" }, "httpBody": { "description": "The POST call's request body.", "maxLength": 4096, "minLength": 1, "type": "string" }, "httpMethod": { "default": "GET", "description": "HTTP method you want to use to run the operation, either `HEAD`, `POST`, or the default `GET` method.", "type": "string", "enum": [ "HEAD", "GET", "POST" ] }, "mdtLocationId": { "description": "Unique identifier for an available location closest to your end users. To get this value, run the [List available locations for metadata tracing](https://techdocs.akamai.com/edge-diagnostics/reference/get-mdt-locations) operation first. For `GET` and `HEAD`, provide either this value or `edgeIp`.", "minLength": 1, "type": "string" }, "requestHeaders": { "description": "Customized headers for metadata tracer request in the format `header: value`. Check [Pragma headers](https://techdocs.akamai.com/edge-diagnostics/docs/pragma-headers) for the list of Akamized Pragma headers you can use here.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } }, "sensitiveRequestHeaderKeys": { "description": "Sensitive `requestHeaders` you don't want to store in the database after running the request. Check [Sensitive headers](https://techdocs.akamai.com/edge-diagnostics/reference/sensitive-headers) to see the list of request headers treated as sensitive by default.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } }, "url": { "description": "URL configured in Property Manager you want to get the metadata trace for.", "format": "uri", "type": "string" }, "useStaging": { "description": "Runs the request on the staging environment, `false` by default. ", "type": "boolean" } }, "x-akamai": { "file-path": "schemas/mdtRequest.yaml" } }, "requestId": { "description": "Unique identifier for the metadata tracer request. Store this value to run [Check a metadata tracing request status](https://techdocs.akamai.com/edge-diagnostics/reference/get-mdt-request) operation.", "minimum": 1, "type": "integer" }, "result": { "additionalProperties": false, "description": "Collects results of the metadata tracer command.", "type": "object", "required": [ "exitCode" ], "properties": { "arlDataXml": { "description": "ARL file from Property Manager.", "minLength": 1, "type": "string" }, "exitCode": { "description": "CURL command [exit code](https://curl.se/libcurl/c/libcurl-errors.html). ", "minimum": 0, "type": "integer" }, "httpStatusCode": { "description": "Returned HTTP response code.", "minimum": 0, "type": "integer" }, "httpVersion": { "description": "HTTP version used for metadata tracer.", "minLength": 1, "type": "string" }, "reasonPhrase": { "description": "Reason phrase for the response.", "minLength": 1, "type": "string" }, "responseHeaderList": { "description": "Collects the response headers in `header: value` format.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } }, "traceInformation": { "description": "Lines executed in XML metadata.", "minItems": 0, "type": "array", "items": { "additionalProperties": false, "description": "Lines executed in XML metadata. ", "type": "object", "required": [ "line", "stages" ], "properties": { "line": { "description": "Line number in the XML metadata file.", "minimum": 1, "type": "integer" }, "stages": { "additionalProperties": false, "description": "Metadata stages at which the line executed.", "type": "object", "required": [ "successes", "failures" ], "properties": { "failures": { "description": "Stages at which the line execution failed. To learn more about them, see [How to read the results](https://techdocs.akamai.com/edge-diagnostics/reference/mdt-results).", "minItems": 0, "type": "array", "items": { "type": "string", "enum": [ "S0_CLIENT_REQUEST", "S1_CLIENT_REQUEST_BODY", "S2_IPA_RESPONSE", "S3_CACHE_HIT", "S4_FORWARD_START", "S5_FORWARD_REQUEST", "S6_FORWARD_RESPONSE", "S7_CLIENT_RESPONSE", "S8_CLIENT_DONE", "S9_CONTENT_POLICY", "S10_FORWARD_INSUFFICIENT_RESPONSE" ] } }, "successes": { "description": "Stages at which the line executed successfully. To learn more about them, see [How to read the results](https://techdocs.akamai.com/edge-diagnostics/reference/mdt-results).", "minItems": 0, "type": "array", "items": { "type": "string", "enum": [ "S0_CLIENT_REQUEST", "S1_CLIENT_REQUEST_BODY", "S2_IPA_RESPONSE", "S3_CACHE_HIT", "S4_FORWARD_START", "S5_FORWARD_REQUEST", "S6_FORWARD_RESPONSE", "S7_CLIENT_RESPONSE", "S8_CLIENT_DONE", "S9_CONTENT_POLICY", "S10_FORWARD_INSUFFICIENT_RESPONSE" ] } } } } }, "x-akamai": { "file-path": "schemas/mdtTraceInformation.yaml" } } } }, "x-akamai": { "file-path": "schemas/mdtResults.yaml" } }, "retryAfter": { "description": "Number of seconds when the request is estimated to have processed. It occurs only for operations with the `IN_PROGRESS` status.", "minimum": 0, "type": "integer" }, "summary": { "additionalProperties": false, "description": "Summary for the metadata tracer operation.", "type": "object", "properties": { "accountId": { "description": "Identifier for the account the metadata tracer was run for. ", "type": "string" }, "assetId": { "description": "Identifier for the asset the metadata tracer was run for.", "type": "string" }, "contractId": { "description": "Identifier for the contract.", "type": "string" }, "groupId": { "description": "Identifier for the group. The value may be `null` for properties provisioned by only one contract.", "type": "string" }, "propertyId": { "description": "Identifier for the property the metadata tracer was run for.", "type": "string" }, "propertyName": { "description": "Name of the property the metadata tracer was run for.", "type": "string" }, "propertyVersion": { "description": "Version of the property that a rule tree represents.", "type": "integer" }, "ruleFormat": { "description": "Versioned set of features and criteria that are currently applied to a rule tree. To learn more, check [API versioning](https://techdocs.akamai.com/property-mgr/reference/api-versioning).", "type": "string" }, "rules": { "additionalProperties": false, "description": "Specifies the executable logic to apply to cached edge content. The outer envelope's `rules` object specifies the relevant top-level `default` rule object. To learn more, check [Rule trees](https://techdocs.akamai.com/property-mgr/reference/rule-trees).", "type": "object", "required": [ "name", "options", "uuid", "children", "behaviors", "criteria", "criteriaMustSatisfy", "variables", "comments" ], "properties": { "options": { "additionalProperties": false, "description": "Flags that apply to the top-level rule object.", "type": "object", "properties": { "is_secure": { "description": "When enabled, serves the property's content over SSL. Doing so may enable additional rule behaviors.", "type": "boolean" } } }, "behaviors": { "description": "Series of [behavior](https://techdocs.akamai.com/property-mgr/reference/latest-behaviors) objects, which execute after the set of `criteria` evaluates. Behavior and criteria objects are structured identically. Optional on nested rules.", "minItems": 0, "type": "array", "items": { "allOf": [ { "additionalProperties": false, "type": "object", "required": [ "name", "options" ], "properties": { "options": { "description": "A variable set of options that configure each behavior. See the [behavior](https://techdocs.akamai.com/edge-diagnostics/reference/ga-behaviors) and [criteria](https://techdocs.akamai.com/edge-diagnostics/reference/ga-criteria) reference for details on each.", "type": "object" }, "locked": { "description": "Indicates a behavior or criteria that you arrange with your Akamai representative to lock. Typically, you prevent further modifications to protect sensitive data from erroneous changes.", "type": "string" }, "name": { "description": "The name of the behavior.", "type": "string" }, "uuid": { "description": "A data hash that indicates an _advanced_ behavior. When present, you may not modify the contents of the behavior, and need to provide the same `uuid` value when modifying the rule tree. See [Advanced and locked features](https://techdocs.akamai.com/edge-diagnostics/reference/advanced-and-locked-features).", "type": "string" } } }, { "additionalProperties": false, "properties": { "executionStatus": { "description": "Status of the behavior's execution. Possible values are `SUCCESS`, `PARTIAL_SUCCESS`, `INDETERMINATE`, `FAILURE`, or `NOT_EXECUTED`. The `INDETERMINATE` status means that the summary for this behavior wasn't generated and you need to refer to the XML to verify it.", "type": "string", "enum": [ "SUCCESS", "FAILURE", "NOT_EXECUTED", "PARTIAL_SUCCESS", "INDETERMINATE" ] }, "lineRange": { "additionalProperties": false, "description": "Line range of the behavior.", "type": "object", "properties": { "end": { "description": "End line number of a behavior in `arlDataXml`.", "minimum": 1, "type": "integer" }, "start": { "description": "Start line number of a behavior in `arlDataXml`.", "minimum": 1, "type": "integer" } }, "x-akamai": { "file-path": "schemas/lineRange.yaml" } } } } ] } }, "children": { "description": "Series of nested rules that execute after the current rule's `criteria` and `behaviors`.", "minItems": 0, "type": "array", "items": { "type": "object" } }, "comments": { "description": "Comment that helps track the rule's function in Property Manager.", "minLength": 1, "type": "string" }, "criteria": { "description": "Series of [criteria](https://techdocs.akamai.com/property-mgr/reference/latest-criteria) objects, which form a set of logical tests that may prevent the rule's `behaviors` from executing. Behavior and criteria objects are structured identically. ", "type": "array", "items": { "type": "object" } }, "criteriaMustSatisfy": { "description": "Collects the response headers in the format `header: value`.", "minLength": 1, "type": "string" }, "name": { "description": "Name of the rule.", "minLength": 1, "type": "string" }, "uuid": { "description": "Data hash that indicates the rule contains at least one _advanced_ behavior or criteria.", "minLength": 1, "type": "string" }, "variables": { "description": "Specifies a variable. To learn more, see [Variables](https://techdocs.akamai.com/property-mgr/reference/variables).", "minItems": 0, "type": "array", "items": { "additionalProperties": false, "type": "object", "required": [ "hidden", "name", "sensitive" ], "properties": { "description": { "description": "Text for you to keep track of how you use each variable.", "type": "string" }, "hidden": { "description": "When enabled, the variable is suppressed from session response headers. Useful when testing content as described in the [Debug variables](https://techdocs.akamai.com/edge-diagnostics/reference/debug-variables) section.", "type": "boolean" }, "name": { "description": "The underlying root name of the variable, which needs to be unique within the set of `variables`.", "type": "string" }, "sensitive": { "description": "When enabled, the variable is suppressed from session responses as `hidden` ones, but it also can't be invoked within any behaviors that assign values to cookies or response headers. You also can't assign a `sensitive` variable to another one that isn't `sensitive`, and you can't add it to custom logging fields. Use this more stringent option for any personally identifiable information, typically after initially testing on the staging network.", "type": "boolean" }, "value": { "description": "Initializes a default value. Omitting this member initializes the variable with an empty string.", "type": "string" } } } } }, "x-akamai": { "file-path": "schemas/papiRuleNode.yaml" } } }, "x-akamai": { "file-path": "schemas/summary.yaml" } } }, "x-akamai": { "file-path": "schemas/mdtResponse.yaml" } } } }, "headers": { "X-RateLimit-Limit": { "description": "The rate limit ceiling for this endpoint.", "example": 10, "schema": { "type": "integer" }, "x-akamai": { "file-path": "headers/X-RateLimit-Limit.yaml" } }, "X-RateLimit-Remaining": { "description": "The number of requests left for the time window.", "example": 5, "schema": { "type": "integer" }, "x-akamai": { "file-path": "headers/X-RateLimit-Remaining.yaml" } } } }, "400": { "description": "[Validation error](https://techdocs.akamai.com/edge-diagnostics/reference/400).", "content": { "application/problem+json": { "example": { "detail": "Provide only one of these members, either `edgeLocationId` or `edgeIp`.", "status": 400, "title": "Incorrect request.", "type": "bad.request.error", "errors": [ { "requestField": "edgeLocationId", "title": "Conflicting values.", "type": "field.conflict" }, { "requestField": "edgeIp", "title": "Conflicting values.", "type": "field.conflict" } ] }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/400.yaml" } }, "401": { "description": "[Authorization error](https://techdocs.akamai.com/edge-diagnostics/reference/401).", "content": { "application/problem+json": { "example": { "detail": "Inactive client token", "instance": "https://akab-nedrvuylepskzabx-lv3dgceqqktx3i5b.luna.akamaiapis.net/edge-diagnostics/v1/grep/requests", "status": 401, "title": "Not authorized", "type": "https://problems.luna.akamaiapis.net/-/pep-authn/deny" }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/401.yaml" } }, "403": { "description": "[Permission error](https://techdocs.akamai.com/edge-diagnostics/reference/403).", "content": { "application/problem+json": { "example": { "status": 403, "title": "Forbidden request.", "type": "forbidden.request.error", "errors": [ { "detail": "You don't have access to the requested URL. Contact your Admin to request access.", "requestField": "url", "title": "Field access denied.", "type": "field.access.denied" } ] }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/403.yaml" } }, "405": { "description": "[Method not allowed](https://techdocs.akamai.com/edge-diagnostics/reference/405).", "content": { "application/problem+json": { "example": { "title": "Method not allowed", "type": "method.not.allowed" }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/405.yaml" } }, "429": { "description": "[Too many requests](https://techdocs.akamai.com/edge-diagnostics/reference/429).", "content": { "application/problem+json": { "example": { "detail": "You have exceeded total number of requests configured for this API.", "status": 429, "title": "Too Many Requests", "type": "requests.exceeded.error" }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/429.yaml" } } }, "parameters": [ { "description": "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ] } }, "/metadata-tracer/locations": { "get": { "description": "Lists active locations you can use to run the [Launch a metadata tracing request](https://techdocs.akamai.com/edge-diagnostics/reference/post-mdt) operation together with information about supported HTTP methods. The operation responds with a subset of edge servers returned by the [List available edge server locations](https://techdocs.akamai.com/edge-diagnostics/reference/get-edge-locations) operation.", "operationId": "get-mdt-locations", "summary": "List available edge server locations for metadata tracing", "tags": [ "Metadata Tracer" ], "externalDocs": { "description": "See documentation for this operation in Akamai's Edge Diagnostics API", "url": "https://techdocs.akamai.com/edge-diagnostics/reference/get-mdt-locations" }, "responses": { "200": { "description": "The response lists the supported locations and HTTP methods for metadata tracing.", "content": { "application/json": { "example": { "mdtLocations": [ { "id": "adelaide-sa-australia", "value": "Adelaide, SA, Australia", "supportedMethods": [ "GET", "POST" ] }, { "id": "amsterdam-netherlands", "value": "Amsterdam, Netherlands", "supportedMethods": [ "POST" ] } ] }, "schema": { "additionalProperties": false, "description": "Collects available locations you can run the [Launch a metadata tracing request](https://techdocs.akamai.com/edge-diagnostics/reference/post-mdt) operation with.", "type": "object", "required": [ "mdtLocations" ], "properties": { "mdtLocations": { "description": "Lists identifiers, names, and supported HTTP methods of available locations.", "minItems": 0, "type": "array", "items": { "additionalProperties": false, "type": "object", "required": [ "id", "value" ], "properties": { "id": { "description": "Unique identifier for the location. Use this value for a `mdtLocationId` member in the [Launch a metadata tracing request](https://techdocs.akamai.com/edge-diagnostics/reference/post-mdt) operation.", "minLength": 1, "type": "string" }, "supportedMethods": { "description": "Lists HTTP methods supported by the location, either `HEAD`, `GET`, or `POST`.", "minItems": 0, "type": "array", "items": { "type": "string", "enum": [ "HEAD", "GET", "POST" ] } }, "value": { "description": "Name of the location.", "minLength": 1, "type": "string" } } } } }, "x-akamai": { "file-path": "schemas/mdtLocations.yaml" } } } }, "headers": { "X-RateLimit-Limit": { "description": "The rate limit ceiling for this endpoint.", "example": 10, "schema": { "type": "integer" }, "x-akamai": { "file-path": "headers/X-RateLimit-Limit.yaml" } }, "X-RateLimit-Remaining": { "description": "The number of requests left for the time window.", "example": 5, "schema": { "type": "integer" }, "x-akamai": { "file-path": "headers/X-RateLimit-Remaining.yaml" } } } }, "400": { "description": "[Validation error](https://techdocs.akamai.com/edge-diagnostics/reference/400).", "content": { "application/problem+json": { "example": { "detail": "Provide only one of these members, either `edgeLocationId` or `edgeIp`.", "status": 400, "title": "Incorrect request.", "type": "bad.request.error", "errors": [ { "requestField": "edgeLocationId", "title": "Conflicting values.", "type": "field.conflict" }, { "requestField": "edgeIp", "title": "Conflicting values.", "type": "field.conflict" } ] }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/400.yaml" } }, "401": { "description": "[Authorization error](https://techdocs.akamai.com/edge-diagnostics/reference/401).", "content": { "application/problem+json": { "example": { "detail": "Inactive client token", "instance": "https://akab-nedrvuylepskzabx-lv3dgceqqktx3i5b.luna.akamaiapis.net/edge-diagnostics/v1/grep/requests", "status": 401, "title": "Not authorized", "type": "https://problems.luna.akamaiapis.net/-/pep-authn/deny" }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/401.yaml" } }, "429": { "description": "[Too many requests](https://techdocs.akamai.com/edge-diagnostics/reference/429).", "content": { "application/problem+json": { "example": { "detail": "You have exceeded total number of requests configured for this API.", "status": 429, "title": "Too Many Requests", "type": "requests.exceeded.error" }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/429.yaml" } } }, "parameters": [ { "description": "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ] } }, "/metadata-tracer/requests/{requestId}": { "get": { "description": "Returns the status of the [asynchronous](https://techdocs.akamai.com/edge-diagnostics/reference/asynchronous-processes) [Launch a Metadata Tracer request](https://techdocs.akamai.com/edge-diagnostics/reference/post-mdt) operation. For operations with the `SUCCESS` status, the response includes the metadata details. For requests with the `Accept: text/html` request header, results are in static HTML format. To learn more about the results, check [How to read the results](https://techdocs.akamai.com/edge-diagnostics/reference/mdt-results).", "operationId": "get-mdt-request", "summary": "Check a metadata tracing request status", "tags": [ "Metadata Tracer" ], "externalDocs": { "description": "See documentation for this operation in Akamai's Edge Diagnostics API", "url": "https://techdocs.akamai.com/edge-diagnostics/reference/get-mdt-request" }, "responses": { "200": { "description": "The response provides the status of the request and its details, represented either as JSON or HTML. To learn more about the results, check [How to read the results](https://techdocs.akamai.com/edge-diagnostics/reference/mdt-results).", "content": { "application/json": { "example": { "completedTime": "2021-04-20T08:50:36Z", "createdBy": "jsmith", "createdTime": "2021-04-20T08:50:34Z", "executionStatus": "SUCCESS", "internalIp": "192.0.2.12", "requestId": 241, "edgeIpLocation": { "asNumber": 123, "city": "TOKYO", "countryCode": "JP", "regionCode": "13" }, "request": { "edgeIp": "192.0.2.12", "url": "https://www.example.com", "requestHeaders": [ "Connection: keep-alive", "Accept-Language: en-US" ] }, "result": { "arlDataXml": "\n\n\n\n \n \n \n \n \n \n \n \n \n \n Fresca\n \n 15\n \n \n AKA_PM_FLAGS\n -\n on\n \n \n AKA_PM_PROPERTY_NAME\n mdt.stmtesting.com\n \n \n AKA_PM_PROPERTY_VERSION\n 15\n \n 1.1\n on\n CONNECTION\n \n ", "httpStatusCode": 200, "httpVersion": "HTTP/1.1", "reasonPhrase": "OK", "responseHeaderList": [ "X-Cache: HIT", "Cache-Control: max-age=604800", "Date: Tue, 20 Apr 2021 08:50:35 GMT", "Content-Type: text/html; charset=UTF-8" ], "traceInformation": [ { "line": 15, "stages": { "failures": [], "successes": [ "S0_CLIENT_REQUEST" ] } }, { "line": 28, "stages": { "failures": [], "successes": [ "S7_CLIENT_RESPONSE" ] } } ] }, "summary": { "accountId": "A-CCT1234", "assetId": "456134", "contractId": "K-0N7RAK7", "groupId": "67223", "propertyId": "763347", "propertyName": "mdt.stmtesting.com", "propertyVersion": 15, "ruleFormat": "latest", "rules": { "comments": "The Default Rule template contains all the necessary and recommended behaviors. Rules are evaluated from top to bottom and the last matching rule wins.", "name": "default", "uuid": "default", "options": { "is_secure": false }, "behaviors": [ { "executionStatus": "NOT_EXECUTED", "name": "origin", "options": { "cacheKeyHostname": "REQUEST_HOST_HEADER", "compress": true, "enableTrueClientIp": true, "forwardHostHeader": "ORIGIN_HOSTNAME", "httpPort": 80, "httpsPort": 443 }, "lineRange": { "end": 141, "start": 140 } }, { "executionStatus": "NOT_EXECUTED", "name": "edgeScape", "options": { "enabled": true }, "lineRange": { "end": 105, "start": 152 } } ], "children": [ { "criteriaMustSatisfy": "any", "name": "OR Rule", "children": [], "behaviors": [ { "executionStatus": "NOT_EXECUTED", "name": "origin", "options": { "cacheKeyHostname": "ORIGIN_HOSTNAME", "compress": true, "originCertificate": "", "originSni": false, "ports": "", "verificationMode": "PLATFORM_SETTINGS" }, "lineRange": { "end": 105, "start": 102 } }, { "executionStatus": "NOT_EXECUTED", "name": "cpCode", "options": { "value": { "createdDate": 1580378379000, "description": "t1info.stmtesting.com", "id": 928922, "name": "t1info.stmtesting.com", "products": [ "Fresca" ] } }, "lineRange": { "end": 125, "start": 112 } } ], "criteria": [ { "name": "userLocation", "options": { "checkIps": "BOTH", "field": "COUNTRY", "matchOperator": "IS_ONE_OF", "useOnlyFirstXForwardedForIp": false, "countryValues": [ "IL" ] } } ] }, { "criteriaMustSatisfy": "all", "name": "AND Rule", "children": [], "behaviors": [ { "executionStatus": "NOT_EXECUTED", "name": "origin", "options": { "httpPort": 80, "httpsPort": 443, "originCertificate": "", "originSni": true, "ports": "", "trueClientIpClientSetting": false, "trueClientIpHeader": "True-Client-IP", "verificationMode": "PLATFORM_SETTINGS" }, "lineRange": { "end": 135, "start": 130 } } ], "criteria": [ { "name": "path", "options": { "matchCaseSensitive": false, "matchOperator": "MATCHES_ONE_OF", "normalize": false, "values": [ "/echo" ] } }, { "name": "hostname", "options": { "matchOperator": "IS_ONE_OF", "values": [ "mdt.stmtesting.com" ] } } ] } ], "variables": [ { "description": "", "hidden": false, "name": "PMUSER_TEST_VAR", "sensitive": false, "value": "" } ] } } }, "schema": { "additionalProperties": false, "description": "Collects the metadata tracer response and details about the request.", "type": "object", "required": [ "requestId", "executionStatus", "createdBy", "createdTime", "request" ], "properties": { "completedTime": { "description": "ISO 8601 timestamp indicating when the request was completed.", "format": "date-time", "type": "string" }, "createdBy": { "description": "Username who submitted the request.", "minLength": 1, "type": "string" }, "createdTime": { "description": "ISO 8601 timestamp indicating when the request was submitted.", "format": "date-time", "type": "string" }, "edgeIpLocation": { "additionalProperties": false, "description": "Specifies the geolocation of the edge server used to run the operation.", "type": "object", "required": [ "city", "regionCode", "countryCode", "asNumber" ], "properties": { "asNumber": { "description": "Autonomous System Number the edge IP maps to.", "minimum": 0, "type": "integer" }, "city": { "description": "Closest city within a 50-mile radius the edge IP maps to.", "minLength": 1, "type": "string" }, "countryCode": { "description": "ISO 3166 country code the edge IP maps to.", "minLength": 1, "type": "string" }, "regionCode": { "description": "ISO 3166 region code the edge IP maps to.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/edgeIpLocation.yaml" } }, "executionStatus": { "description": "Status of the request's execution. Possible values are `SUCCESS`, `FAILURE`, or `IN_PROGRESS`.", "type": "string", "enum": [ "SUCCESS", "FAILURE", "IN_PROGRESS" ] }, "internalIp": { "description": "If your request contained `edgeLocationId` then this is the IP of a machine in that location. If you run the operation for a virtual IP, then this is the IP of a machine behind that virtual IP.", "minLength": 1, "type": "string" }, "link": { "description": "Link to get fetched metadata tracer response after the `retryAfter` interval passes. It occurs only for operations with the `IN_PROGRESS` status.", "minLength": 1, "type": "string" }, "request": { "additionalProperties": false, "description": "Specifies your request.", "type": "object", "required": [ "url" ], "properties": { "edgeIp": { "description": "IP of the edge server you want to run the operation from. If you don't know if an IP is the edge IP, run the [Verify an IP](https://techdocs.akamai.com/edge-diagnostics/reference/post-verify-edge-ip) operation. Provide either this value or `mdtLocationId`.", "minLength": 1, "type": "string" }, "httpBody": { "description": "The POST call's request body.", "maxLength": 4096, "minLength": 1, "type": "string" }, "httpMethod": { "default": "GET", "description": "HTTP method you want to use to run the operation, either `HEAD`, `POST`, or the default `GET` method.", "type": "string", "enum": [ "HEAD", "GET", "POST" ] }, "mdtLocationId": { "description": "Unique identifier for an available location closest to your end users. To get this value, run the [List available locations for metadata tracing](https://techdocs.akamai.com/edge-diagnostics/reference/get-mdt-locations) operation first. For `GET` and `HEAD`, provide either this value or `edgeIp`.", "minLength": 1, "type": "string" }, "requestHeaders": { "description": "Customized headers for metadata tracer request in the format `header: value`. Check [Pragma headers](https://techdocs.akamai.com/edge-diagnostics/docs/pragma-headers) for the list of Akamized Pragma headers you can use here.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } }, "sensitiveRequestHeaderKeys": { "description": "Sensitive `requestHeaders` you don't want to store in the database after running the request. Check [Sensitive headers](https://techdocs.akamai.com/edge-diagnostics/reference/sensitive-headers) to see the list of request headers treated as sensitive by default.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } }, "url": { "description": "URL configured in Property Manager you want to get the metadata trace for.", "format": "uri", "type": "string" }, "useStaging": { "description": "Runs the request on the staging environment, `false` by default. ", "type": "boolean" } }, "x-akamai": { "file-path": "schemas/mdtRequest.yaml" } }, "requestId": { "description": "Unique identifier for the metadata tracer request. Store this value to run [Check a metadata tracing request status](https://techdocs.akamai.com/edge-diagnostics/reference/get-mdt-request) operation.", "minimum": 1, "type": "integer" }, "result": { "additionalProperties": false, "description": "Collects results of the metadata tracer command.", "type": "object", "required": [ "exitCode" ], "properties": { "arlDataXml": { "description": "ARL file from Property Manager.", "minLength": 1, "type": "string" }, "exitCode": { "description": "CURL command [exit code](https://curl.se/libcurl/c/libcurl-errors.html). ", "minimum": 0, "type": "integer" }, "httpStatusCode": { "description": "Returned HTTP response code.", "minimum": 0, "type": "integer" }, "httpVersion": { "description": "HTTP version used for metadata tracer.", "minLength": 1, "type": "string" }, "reasonPhrase": { "description": "Reason phrase for the response.", "minLength": 1, "type": "string" }, "responseHeaderList": { "description": "Collects the response headers in `header: value` format.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } }, "traceInformation": { "description": "Lines executed in XML metadata.", "minItems": 0, "type": "array", "items": { "additionalProperties": false, "description": "Lines executed in XML metadata. ", "type": "object", "required": [ "line", "stages" ], "properties": { "line": { "description": "Line number in the XML metadata file.", "minimum": 1, "type": "integer" }, "stages": { "additionalProperties": false, "description": "Metadata stages at which the line executed.", "type": "object", "required": [ "successes", "failures" ], "properties": { "failures": { "description": "Stages at which the line execution failed. To learn more about them, see [How to read the results](https://techdocs.akamai.com/edge-diagnostics/reference/mdt-results).", "minItems": 0, "type": "array", "items": { "type": "string", "enum": [ "S0_CLIENT_REQUEST", "S1_CLIENT_REQUEST_BODY", "S2_IPA_RESPONSE", "S3_CACHE_HIT", "S4_FORWARD_START", "S5_FORWARD_REQUEST", "S6_FORWARD_RESPONSE", "S7_CLIENT_RESPONSE", "S8_CLIENT_DONE", "S9_CONTENT_POLICY", "S10_FORWARD_INSUFFICIENT_RESPONSE" ] } }, "successes": { "description": "Stages at which the line executed successfully. To learn more about them, see [How to read the results](https://techdocs.akamai.com/edge-diagnostics/reference/mdt-results).", "minItems": 0, "type": "array", "items": { "type": "string", "enum": [ "S0_CLIENT_REQUEST", "S1_CLIENT_REQUEST_BODY", "S2_IPA_RESPONSE", "S3_CACHE_HIT", "S4_FORWARD_START", "S5_FORWARD_REQUEST", "S6_FORWARD_RESPONSE", "S7_CLIENT_RESPONSE", "S8_CLIENT_DONE", "S9_CONTENT_POLICY", "S10_FORWARD_INSUFFICIENT_RESPONSE" ] } } } } }, "x-akamai": { "file-path": "schemas/mdtTraceInformation.yaml" } } } }, "x-akamai": { "file-path": "schemas/mdtResults.yaml" } }, "retryAfter": { "description": "Number of seconds when the request is estimated to have processed. It occurs only for operations with the `IN_PROGRESS` status.", "minimum": 0, "type": "integer" }, "summary": { "additionalProperties": false, "description": "Summary for the metadata tracer operation.", "type": "object", "properties": { "accountId": { "description": "Identifier for the account the metadata tracer was run for. ", "type": "string" }, "assetId": { "description": "Identifier for the asset the metadata tracer was run for.", "type": "string" }, "contractId": { "description": "Identifier for the contract.", "type": "string" }, "groupId": { "description": "Identifier for the group. The value may be `null` for properties provisioned by only one contract.", "type": "string" }, "propertyId": { "description": "Identifier for the property the metadata tracer was run for.", "type": "string" }, "propertyName": { "description": "Name of the property the metadata tracer was run for.", "type": "string" }, "propertyVersion": { "description": "Version of the property that a rule tree represents.", "type": "integer" }, "ruleFormat": { "description": "Versioned set of features and criteria that are currently applied to a rule tree. To learn more, check [API versioning](https://techdocs.akamai.com/property-mgr/reference/api-versioning).", "type": "string" }, "rules": { "additionalProperties": false, "description": "Specifies the executable logic to apply to cached edge content. The outer envelope's `rules` object specifies the relevant top-level `default` rule object. To learn more, check [Rule trees](https://techdocs.akamai.com/property-mgr/reference/rule-trees).", "type": "object", "required": [ "name", "options", "uuid", "children", "behaviors", "criteria", "criteriaMustSatisfy", "variables", "comments" ], "properties": { "options": { "additionalProperties": false, "description": "Flags that apply to the top-level rule object.", "type": "object", "properties": { "is_secure": { "description": "When enabled, serves the property's content over SSL. Doing so may enable additional rule behaviors.", "type": "boolean" } } }, "behaviors": { "description": "Series of [behavior](https://techdocs.akamai.com/property-mgr/reference/latest-behaviors) objects, which execute after the set of `criteria` evaluates. Behavior and criteria objects are structured identically. Optional on nested rules.", "minItems": 0, "type": "array", "items": { "allOf": [ { "additionalProperties": false, "type": "object", "required": [ "name", "options" ], "properties": { "options": { "description": "A variable set of options that configure each behavior. See the [behavior](https://techdocs.akamai.com/edge-diagnostics/reference/ga-behaviors) and [criteria](https://techdocs.akamai.com/edge-diagnostics/reference/ga-criteria) reference for details on each.", "type": "object" }, "locked": { "description": "Indicates a behavior or criteria that you arrange with your Akamai representative to lock. Typically, you prevent further modifications to protect sensitive data from erroneous changes.", "type": "string" }, "name": { "description": "The name of the behavior.", "type": "string" }, "uuid": { "description": "A data hash that indicates an _advanced_ behavior. When present, you may not modify the contents of the behavior, and need to provide the same `uuid` value when modifying the rule tree. See [Advanced and locked features](https://techdocs.akamai.com/edge-diagnostics/reference/advanced-and-locked-features).", "type": "string" } } }, { "additionalProperties": false, "properties": { "executionStatus": { "description": "Status of the behavior's execution. Possible values are `SUCCESS`, `PARTIAL_SUCCESS`, `INDETERMINATE`, `FAILURE`, or `NOT_EXECUTED`. The `INDETERMINATE` status means that the summary for this behavior wasn't generated and you need to refer to the XML to verify it.", "type": "string", "enum": [ "SUCCESS", "FAILURE", "NOT_EXECUTED", "PARTIAL_SUCCESS", "INDETERMINATE" ] }, "lineRange": { "additionalProperties": false, "description": "Line range of the behavior.", "type": "object", "properties": { "end": { "description": "End line number of a behavior in `arlDataXml`.", "minimum": 1, "type": "integer" }, "start": { "description": "Start line number of a behavior in `arlDataXml`.", "minimum": 1, "type": "integer" } }, "x-akamai": { "file-path": "schemas/lineRange.yaml" } } } } ] } }, "children": { "description": "Series of nested rules that execute after the current rule's `criteria` and `behaviors`.", "minItems": 0, "type": "array", "items": { "type": "object" } }, "comments": { "description": "Comment that helps track the rule's function in Property Manager.", "minLength": 1, "type": "string" }, "criteria": { "description": "Series of [criteria](https://techdocs.akamai.com/property-mgr/reference/latest-criteria) objects, which form a set of logical tests that may prevent the rule's `behaviors` from executing. Behavior and criteria objects are structured identically. ", "type": "array", "items": { "type": "object" } }, "criteriaMustSatisfy": { "description": "Collects the response headers in the format `header: value`.", "minLength": 1, "type": "string" }, "name": { "description": "Name of the rule.", "minLength": 1, "type": "string" }, "uuid": { "description": "Data hash that indicates the rule contains at least one _advanced_ behavior or criteria.", "minLength": 1, "type": "string" }, "variables": { "description": "Specifies a variable. To learn more, see [Variables](https://techdocs.akamai.com/property-mgr/reference/variables).", "minItems": 0, "type": "array", "items": { "additionalProperties": false, "type": "object", "required": [ "hidden", "name", "sensitive" ], "properties": { "description": { "description": "Text for you to keep track of how you use each variable.", "type": "string" }, "hidden": { "description": "When enabled, the variable is suppressed from session response headers. Useful when testing content as described in the [Debug variables](https://techdocs.akamai.com/edge-diagnostics/reference/debug-variables) section.", "type": "boolean" }, "name": { "description": "The underlying root name of the variable, which needs to be unique within the set of `variables`.", "type": "string" }, "sensitive": { "description": "When enabled, the variable is suppressed from session responses as `hidden` ones, but it also can't be invoked within any behaviors that assign values to cookies or response headers. You also can't assign a `sensitive` variable to another one that isn't `sensitive`, and you can't add it to custom logging fields. Use this more stringent option for any personally identifiable information, typically after initially testing on the staging network.", "type": "boolean" }, "value": { "description": "Initializes a default value. Omitting this member initializes the variable with an empty string.", "type": "string" } } } } }, "x-akamai": { "file-path": "schemas/papiRuleNode.yaml" } } }, "x-akamai": { "file-path": "schemas/summary.yaml" } } }, "x-akamai": { "file-path": "schemas/mdtResponse.yaml" } } }, "text/html": { "example": "\n\n \n \n MetadataTrace\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
Request Details
Request ID :220
Created By :user
Execution Status :SUCCESS
Request :URL :https://www.example.com
useStaging :true
 
HTTP/1.0 400 Bad Request
 
Response Headers\n
Server: AkamaiGHost
Mime-Version: 1.0
Content-Type: text/html
Content-Length: 208
Expires: Mon, 27 Jun 2022 05:38:57 GMT
Date: Mon, 27 Jun 2022 05:38:57 GMT
Connection: close
 
\n \n \n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
StagesXML Doc
012345678910Line
-----------1<?xml version="1.0" encoding="UTF-8"?>
-----------2<configs xmlns:cache="uri:akamai.com/metadata/cache/5.0" xmlns:edgeservices="uri:akamai.com/metadata/edgeservices/5.0" xmlns:config="uri:akamai.com/metadata/config/5.0" xmlns:network="uri:akamai.com/metadata/network/5.0" xmlns:autd="uri:akamai.com/metadata/autd/5.0" xmlns:match="uri:akamai.com/metadata/match/5.0" xmlns:forward="uri:akamai.com/metadata/forward/5.0" xmlns:comment="uri:akamai.com/metadata/comment/5.0" xmlns:akamai="uri:akamai.com/metadata/akamai/5.0" xmlns:security="uri:akamai.com/metadata/security/5.0" xmlns:reporting="uri:akamai.com/metadata/reporting/5.0" xmlns:edgecomputing="uri:akamai.com/metadata/edgecomputing/5.0" xmlns:assign="uri:akamai.com/metadata/assign/5.0">
S----------3 <comment:note value="Property Manager generated metadata. XML engine version: 14.2.1"/>
-----------4 <comment:note value="Catalog version: 14.4.4"/>
S------S---5 <comment:note value="Product name: Site_Accel"/>
-----------6 <comment:note value="Property name: example.com, version: 33"/>
-----------7 <comment:note value="Asset ID: 99999"/>
S----S-S---8 <comment:note value="AcgID: "/>
-----------9 <comment:note value="AccountId: A-CCT3456"/>
-----------10 <comment:note value="Hostnames: www.example.com"/>
-----------11</configs>
\n \n" } }, "headers": { "X-RateLimit-Limit": { "description": "The rate limit ceiling for this endpoint.", "example": 10, "schema": { "type": "integer" }, "x-akamai": { "file-path": "headers/X-RateLimit-Limit.yaml" } }, "X-RateLimit-Remaining": { "description": "The number of requests left for the time window.", "example": 5, "schema": { "type": "integer" }, "x-akamai": { "file-path": "headers/X-RateLimit-Remaining.yaml" } } } }, "400": { "description": "[Validation error](https://techdocs.akamai.com/edge-diagnostics/reference/400).", "content": { "application/problem+json": { "example": { "detail": "Provide only one of these members, either `edgeLocationId` or `edgeIp`.", "status": 400, "title": "Incorrect request.", "type": "bad.request.error", "errors": [ { "requestField": "edgeLocationId", "title": "Conflicting values.", "type": "field.conflict" }, { "requestField": "edgeIp", "title": "Conflicting values.", "type": "field.conflict" } ] }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/400.yaml" } }, "401": { "description": "[Authorization error](https://techdocs.akamai.com/edge-diagnostics/reference/401).", "content": { "application/problem+json": { "example": { "detail": "Inactive client token", "instance": "https://akab-nedrvuylepskzabx-lv3dgceqqktx3i5b.luna.akamaiapis.net/edge-diagnostics/v1/grep/requests", "status": 401, "title": "Not authorized", "type": "https://problems.luna.akamaiapis.net/-/pep-authn/deny" }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/401.yaml" } }, "403": { "description": "[Permission error](https://techdocs.akamai.com/edge-diagnostics/reference/403).", "content": { "application/problem+json": { "example": { "status": 403, "title": "Forbidden request.", "type": "forbidden.request.error", "errors": [ { "detail": "You don't have access to the requested URL. Contact your Admin to request access.", "requestField": "url", "title": "Field access denied.", "type": "field.access.denied" } ] }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/403.yaml" } }, "405": { "description": "[Method not allowed](https://techdocs.akamai.com/edge-diagnostics/reference/405).", "content": { "application/problem+json": { "example": { "title": "Method not allowed", "type": "method.not.allowed" }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/405.yaml" } }, "429": { "description": "[Too many requests](https://techdocs.akamai.com/edge-diagnostics/reference/429).", "content": { "application/problem+json": { "example": { "detail": "You have exceeded total number of requests configured for this API.", "status": 429, "title": "Too Many Requests", "type": "requests.exceeded.error" }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/429.yaml" } } }, "parameters": [ { "description": "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ] }, "parameters": [ { "description": "Unique identifier for a request. To get this value, run the corresponding POST operation.", "example": "{{requestId}}", "in": "path", "name": "requestId", "required": true, "schema": { "example": 365, "type": "integer" }, "x-akamai": { "file-path": "parameters/requestId-path.yaml" } } ] }, "/mtr": { "post": { "description": "Uses MTR to provide information about packet loss and latency between an edge server IP, location, or Site Shield map and a remote destination. To run this operation for an IP, you may need to [verify an IP](https://techdocs.akamai.com/edge-diagnostics/reference/post-verify-edge-ip) if it belongs to an edge server. To run this operation for a GTM hostname, run [List GTM properties](https://techdocs.akamai.com/edge-diagnostics/reference/get-gtm-properties) and [List test and target IPs for a GTM hostname](https://techdocs.akamai.com/edge-diagnostics/reference/get-gtm-property-domain-gtm-property-ips) operations first to get the test and target IPs for the hostname.", "operationId": "post-mtr", "summary": "Test network connectivity with MTR", "tags": [ "MTR" ], "externalDocs": { "description": "See documentation for this operation in Akamai's Edge Diagnostics API", "url": "https://techdocs.akamai.com/edge-diagnostics/reference/post-mtr" }, "requestBody": { "required": true, "content": { "application/json": { "example": { "destination": "192.0.2.0", "destinationType": "IP", "packetType": "ICMP", "port": 80, "resolveDns": true, "showIps": true, "showLocations": true, "source": "192.0.2.9", "sourceType": "EDGE_IP" }, "schema": { "additionalProperties": false, "description": "Collects data to use in MTR. Objects created for an IP address or a hostname differ from these created for a GTM hostname in terms of included data.", "type": "object", "required": [ "destinationType", "destination", "packetType", "resolveDns", "showIps", "showLocations" ], "properties": { "destination": { "description": "MTR destination compliant with the `destinationType`, either a hostname or a destination IP. To build an object for a GTM hostname, enter the `target` value returned by the [List test and target IPs for a GTM hostname](https://techdocs.akamai.com/edge-diagnostics/reference/get-gtm-property-domain-gtm-property-ips) operation. For a Site Shield hostname, enter a destination IP address.", "example": "{{destination}}", "minLength": 1, "type": "string" }, "destinationType": { "description": "Type of destination input, either `IP` or `HOST`. To build an object for a GTM or Site Shield hostname, choose `IP`.", "example": "{{destinationType}}", "type": "string", "enum": [ "IP", "HOST" ] }, "packetType": { "description": "Packet type used by MTR, either `ICMP` or `TCP`.", "example": "{{packetType}}", "type": "string", "enum": [ "ICMP", "TCP" ] }, "port": { "description": "Port to use to run MTR, either `80` or `443`. Provide it only for `destinationType` set to `HOST`.", "example": "{{port}}", "type": "integer", "enum": [ 80, 443 ] }, "resolveDns": { "description": "Resolves DNS for each hop.", "example": "{{resolveDns}}", "type": "boolean" }, "showIps": { "description": "Shows IPs for each hop.", "example": "{{showIps}}", "type": "boolean" }, "showLocations": { "description": "Shows locations for each hop.", "example": "{{showLocations}}", "type": "boolean" }, "siteShieldHostname": { "description": "Site Shield hostname you want to run the MTR for.", "example": "{{siteShieldHostname}}", "format": "hostname", "type": "string" }, "source": { "description": "MTR source compliant with the `sourceType`, either an edge server IP or a location. For locations, enter `edgeLocationId` for an edge server location closest to your end users. To get this value, run the [List available edge server locations](https://techdocs.akamai.com/edge-diagnostics/reference/get-edge-locations) operation first. For edge IPs, use the edge server IP value from the `answerSection` array in the [Get domain details with dig](https://techdocs.akamai.com/edge-diagnostics/reference/post-dig) operation response. To build an object for a GTM hostname, enter the `testIp` value returned by the [List test and target IPs for a GTM hostname](https://techdocs.akamai.com/edge-diagnostics/reference/get-gtm-property-domain-gtm-property-ips) operation.", "example": "{{source}}", "minLength": 1, "type": "string" }, "sourceType": { "description": "Type of the source input, either `EDGE_IP` or `LOCATION`. To build an object for a GTM hostname, choose `EDGE_IP`.", "example": "{{sourceType}}", "type": "string", "enum": [ "EDGE_IP", "LOCATION" ] } }, "x-akamai": { "file-path": "schemas/mtrRequest.yaml" } } } } }, "responses": { "200": { "description": "The response provides the MTR results.", "content": { "application/json": { "example": { "completedTime": "2021-03-19T06:46:08Z", "createdBy": "jkowalski", "createdTime": "2021-03-19T06:45:39Z", "executionStatus": "SUCCESS", "sourceInternalIp": "192.0.2.8", "destinationIpLocation": { "asNumber": 20005, "city": "TOKYO", "countryCode": "JP", "regionCode": "13" }, "request": { "destination": "192.0.2.0", "destinationType": "IP", "packetType": "ICMP", "port": 80, "resolveDns": true, "showIps": true, "showLocations": true, "source": "192.0.2.9", "sourceType": "EDGE_IP" }, "result": { "averageLatency": 0.5, "host": "aNNN-NNN-NNN.deploy.akamaitechnologies.com", "packetLoss": 0, "result": "Start: 2021-03-19T06:45:48+0000\nHOST: aNNN-NNN-NNN.deploy.akamaitechnologies.com Loss% Snt Last Avg Best Wrst StDev\n 1.|-- NNN.NNN-NNNN.netarch.akamai.com (192.0.2.7) 0.0% 10 1.3 51.3 1.3 220.1 82.4\n 2.|-- NNN-N-NNNNN.net.telefonicaglobalsolutions.com (192.0.2.0) 0.0% 10 2.2 3.4 0.5 11.9 3.9", "startTime": 1616136348, "hops": [ { "averageLatency": 51.3, "bestRtt": 1.3, "host": "NNN.NNN-NNNN.netarch.akamai.com", "ip": "192.0.2.7", "lastPacketLatency": 1.3, "number": 1, "packetLoss": 0, "sentPackets": 10, "standardDeviation": 82.4, "worstRtt": 220.1, "ipLocation": { "asNumber": 20000, "city": "TOKYO", "countryCode": "JP", "regionCode": "13" } }, { "averageLatency": 0.5, "bestRtt": 0.5, "host": "NNN-N-NNNNN.net.telefonicaglobalsolutions.com", "ip": "192.0.2.0", "lastPacketLatency": 2.2, "number": 2, "packetLoss": 0, "sentPackets": 10, "standardDeviation": 3.9, "worstRtt": 11.9, "ipLocation": { "asNumber": 20001, "city": "TOKYO", "countryCode": "JP", "regionCode": "13" } } ] }, "sourceIpLocation": { "asNumber": 20002, "city": "TOKYO", "countryCode": "JP", "regionCode": "13" } }, "schema": { "additionalProperties": false, "description": "Lists MTR results and details about the request.", "type": "object", "required": [ "completedTime", "createdBy", "createdTime", "destinationInternalIp", "destinationIpLocation", "executionStatus", "request", "result", "sourceInternalIp", "sourceIpLocation" ], "properties": { "completedTime": { "description": "ISO 8601 timestamp indicating when the request was completed.", "format": "date-time", "type": "string" }, "createdBy": { "description": "Username who submitted the request.", "minLength": 1, "type": "string" }, "createdTime": { "description": "ISO 8601 timestamp indicating when the request was submitted.", "format": "date-time", "type": "string" }, "destinationInternalIp": { "description": "Resolved IP for the MTR destination. It appears only when the `destination` in the request was a hostname.", "minLength": 1, "type": "string" }, "destinationIpLocation": { "additionalProperties": false, "description": "Specifies the geolocation of the requested `destination`.", "type": "object", "required": [ "city", "regionCode", "countryCode", "asNumber" ], "properties": { "asNumber": { "description": "Autonomous System Number the edge IP maps to.", "minimum": 0, "type": "integer" }, "city": { "description": "Closest city within a 50-mile radius the edge IP maps to.", "minLength": 1, "type": "string" }, "countryCode": { "description": "ISO 3166 country code the edge IP maps to.", "minLength": 1, "type": "string" }, "regionCode": { "description": "ISO 3166 region code the edge IP maps to.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/edgeIpLocation.yaml" } }, "executionStatus": { "description": "Status of the request's execution, either `SUCCESS` or `FAILURE`.", "type": "string", "enum": [ "SUCCESS", "FAILURE" ] }, "request": { "additionalProperties": false, "description": "Specifies your MTR request.", "type": "object", "required": [ "destinationType", "destination", "packetType", "resolveDns", "showIps", "showLocations" ], "properties": { "destination": { "description": "MTR destination compliant with the `destinationType`, either a hostname or a destination IP. To build an object for a GTM hostname, enter the `target` value returned by the [List test and target IPs for a GTM hostname](https://techdocs.akamai.com/edge-diagnostics/reference/get-gtm-property-domain-gtm-property-ips) operation. For a Site Shield hostname, enter a destination IP address.", "minLength": 1, "type": "string" }, "destinationType": { "description": "Type of destination input, either `IP` or `HOST`. To build an object for a GTM or Site Shield hostname, choose `IP`.", "type": "string", "enum": [ "IP", "HOST" ] }, "packetType": { "description": "Packet type used by MTR, either `ICMP` or `TCP`.", "type": "string", "enum": [ "ICMP", "TCP" ] }, "port": { "description": "Port to use to run MTR, either `80` or `443`. Provide it only for `destinationType` set to `HOST`.", "type": "integer", "enum": [ 80, 443 ] }, "resolveDns": { "description": "Resolves DNS for each hop.", "type": "boolean" }, "showIps": { "description": "Shows IPs for each hop.", "type": "boolean" }, "showLocations": { "description": "Shows locations for each hop.", "type": "boolean" }, "siteShieldHostname": { "description": "Site Shield hostname you want to run the MTR for.", "format": "hostname", "type": "string" }, "source": { "description": "MTR source compliant with the `sourceType`, either an edge server IP or a location. For locations, enter `edgeLocationId` for an edge server location closest to your end users. To get this value, run the [List available edge server locations](https://techdocs.akamai.com/edge-diagnostics/reference/get-edge-locations) operation first. For edge IPs, use the edge server IP value from the `answerSection` array in the [Get domain details with dig](https://techdocs.akamai.com/edge-diagnostics/reference/post-dig) operation response. To build an object for a GTM hostname, enter the `testIp` value returned by the [List test and target IPs for a GTM hostname](https://techdocs.akamai.com/edge-diagnostics/reference/get-gtm-property-domain-gtm-property-ips) operation.", "minLength": 1, "type": "string" }, "sourceType": { "description": "Type of the source input, either `EDGE_IP` or `LOCATION`. To build an object for a GTM hostname, choose `EDGE_IP`.", "type": "string", "enum": [ "EDGE_IP", "LOCATION" ] } }, "x-akamai": { "file-path": "schemas/mtrRequest.yaml" } }, "result": { "additionalProperties": false, "description": "Standard MTR results.", "type": "object", "required": [ "startTime", "host", "packetLoss", "averageLatency", "hops", "result" ], "properties": { "averageLatency": { "description": "Average latency for all hops, in seconds.", "minimum": 0, "type": "number" }, "hops": { "description": "Lists network hops with their data.", "minItems": 0, "type": "array", "items": { "additionalProperties": false, "description": "Collects network hops with their data.", "type": "object", "required": [ "number", "host", "ip", "ipLocation", "packetLoss", "sentPackets", "lastPacketLatency", "averageLatency", "bestRtt", "worstRtt", "standardDeviation" ], "properties": { "averageLatency": { "description": "Average hop value, useful to detect ongoing problems.", "minimum": 0, "type": "number" }, "bestRtt": { "description": "Fastest time, in milliseconds.", "minimum": 0, "type": "number" }, "host": { "description": "Host or domain name for the hop.", "minLength": 1, "type": "string" }, "ip": { "description": "IP of the hop's `edgeHost`.", "minLength": 1, "type": "string" }, "ipLocation": { "additionalProperties": false, "description": "Geolocation data for the hop's `edgeHost`.", "type": "object", "required": [ "city", "regionCode", "countryCode", "asNumber" ], "properties": { "asNumber": { "description": "Autonomous System Number the edge IP maps to.", "minimum": 0, "type": "integer" }, "city": { "description": "Closest city within a 50-mile radius the edge IP maps to.", "minLength": 1, "type": "string" }, "countryCode": { "description": "ISO 3166 country code the edge IP maps to.", "minLength": 1, "type": "string" }, "regionCode": { "description": "ISO 3166 region code the edge IP maps to.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/edgeIpLocation.yaml" } }, "lastPacketLatency": { "description": "Last measured hop value, useful to detect ongoing problems.", "minimum": 0, "type": "number" }, "number": { "description": "Index for each hop's count within the full set.", "minimum": 0, "type": "integer" }, "packetLoss": { "description": "Percentage of packets lost for the hop, maximum `100`.", "maximum": 100, "minimum": 0, "type": "number" }, "sentPackets": { "description": "Number of packets sent for the hop.", "minimum": 0, "type": "integer" }, "standardDeviation": { "description": "Standard deviation, in milliseconds.", "minimum": 0, "type": "number" }, "worstRtt": { "description": "Slowest time, in milliseconds.", "minimum": 0, "type": "number" } }, "x-akamai": { "file-path": "schemas/mtrHopInstance.yaml" } } }, "host": { "description": "Hostname within the edge network that corresponds to the `source` IP address.", "format": "hostname", "type": "string" }, "packetLoss": { "description": "Percentage of packets lost, maximum `100`.", "maximum": 100, "minimum": 0, "type": "number" }, "result": { "description": "Raw MTR utility output.", "minLength": 1, "type": "string" }, "startTime": { "description": "Epoch timestamp marking when MTR was run.", "type": "integer" } }, "x-akamai": { "file-path": "schemas/mtrData.yaml" } }, "siteShieldIp": { "description": "For Site Shield hostnames requests, this is the IP used to run MTR.", "minLength": 1, "type": "string" }, "siteShieldIpLocation": { "additionalProperties": false, "description": "Specifies the geolocation of the edge server used to run the operation. It appears only for Site Shield hostnames requests.", "type": "object", "required": [ "city", "regionCode", "countryCode", "asNumber" ], "properties": { "asNumber": { "description": "Autonomous System Number the edge IP maps to.", "minimum": 0, "type": "integer" }, "city": { "description": "Closest city within a 50-mile radius the edge IP maps to.", "minLength": 1, "type": "string" }, "countryCode": { "description": "ISO 3166 country code the edge IP maps to.", "minLength": 1, "type": "string" }, "regionCode": { "description": "ISO 3166 region code the edge IP maps to.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/edgeIpLocation.yaml" } }, "sourceInternalIp": { "description": "For VIP or location as the source in the request, it's the real IP address behind that VIP or location used for MTR.", "minLength": 1, "type": "string" }, "sourceIpLocation": { "additionalProperties": false, "description": "Specifies the geolocation of the requested `source`.", "type": "object", "required": [ "city", "regionCode", "countryCode", "asNumber" ], "properties": { "asNumber": { "description": "Autonomous System Number the edge IP maps to.", "minimum": 0, "type": "integer" }, "city": { "description": "Closest city within a 50-mile radius the edge IP maps to.", "minLength": 1, "type": "string" }, "countryCode": { "description": "ISO 3166 country code the edge IP maps to.", "minLength": 1, "type": "string" }, "regionCode": { "description": "ISO 3166 region code the edge IP maps to.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/edgeIpLocation.yaml" } } }, "x-akamai": { "file-path": "schemas/mtrResponse.yaml" } } } }, "headers": { "X-RateLimit-Limit": { "description": "The rate limit ceiling for this endpoint.", "example": 10, "schema": { "type": "integer" }, "x-akamai": { "file-path": "headers/X-RateLimit-Limit.yaml" } }, "X-RateLimit-Remaining": { "description": "The number of requests left for the time window.", "example": 5, "schema": { "type": "integer" }, "x-akamai": { "file-path": "headers/X-RateLimit-Remaining.yaml" } } } }, "400": { "description": "[Validation error](https://techdocs.akamai.com/edge-diagnostics/reference/400).", "content": { "application/problem+json": { "example": { "detail": "Provide only one of these members, either `edgeLocationId` or `edgeIp`.", "status": 400, "title": "Incorrect request.", "type": "bad.request.error", "errors": [ { "requestField": "edgeLocationId", "title": "Conflicting values.", "type": "field.conflict" }, { "requestField": "edgeIp", "title": "Conflicting values.", "type": "field.conflict" } ] }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/400.yaml" } }, "401": { "description": "[Authorization error](https://techdocs.akamai.com/edge-diagnostics/reference/401).", "content": { "application/problem+json": { "example": { "detail": "Inactive client token", "instance": "https://akab-nedrvuylepskzabx-lv3dgceqqktx3i5b.luna.akamaiapis.net/edge-diagnostics/v1/grep/requests", "status": 401, "title": "Not authorized", "type": "https://problems.luna.akamaiapis.net/-/pep-authn/deny" }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/401.yaml" } }, "403": { "description": "[Permission error](https://techdocs.akamai.com/edge-diagnostics/reference/403).", "content": { "application/problem+json": { "example": { "status": 403, "title": "Forbidden request.", "type": "forbidden.request.error", "errors": [ { "detail": "You don't have access to the requested URL. Contact your Admin to request access.", "requestField": "url", "title": "Field access denied.", "type": "field.access.denied" } ] }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/403.yaml" } }, "405": { "description": "[Method not allowed](https://techdocs.akamai.com/edge-diagnostics/reference/405).", "content": { "application/problem+json": { "example": { "title": "Method not allowed", "type": "method.not.allowed" }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/405.yaml" } }, "429": { "description": "[Too many requests](https://techdocs.akamai.com/edge-diagnostics/reference/429).", "content": { "application/problem+json": { "example": { "detail": "You have exceeded total number of requests configured for this API.", "status": 429, "title": "Too Many Requests", "type": "requests.exceeded.error" }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/429.yaml" } } }, "parameters": [ { "description": "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ] } }, "/translated-url": { "post": { "description": "Provides basic information about a specific hostname or domain name, such as typecode, origin server, CP code, serial number, and TTL. A URL becomes an [Akamaized URL (ARL)](https://techdocs.akamai.com/edge-diagnostics/docs/arl-syntax) once it's on an edge server.", "operationId": "post-translated-url", "summary": "Translate an Akamaized URL", "tags": [ "ARL translator" ], "externalDocs": { "description": "See documentation for this operation in Akamai's Edge Diagnostics API", "url": "https://techdocs.akamai.com/edge-diagnostics/reference/post-translated-url" }, "requestBody": { "required": true, "content": { "application/json": { "example": { "url": "http://www.example.com" }, "schema": { "additionalProperties": false, "description": "[Akamaized URL](https://techdocs.akamai.com/edge-diagnostics/docs/arl-syntax) you want to get the details for.", "type": "object", "required": [ "url" ], "properties": { "url": { "description": "Fully qualified [Akamaized URL](https://techdocs.akamai.com/edge-diagnostics/docs/arl-syntax) you want to get the details for.", "example": "{{url}}", "type": "string" } }, "x-akamai": { "file-path": "schemas/ArlRequest.yaml" } } } } }, "responses": { "200": { "description": "The response provides details for the ARL.", "content": { "application/json": { "example": { "request": { "url": "http://www.example.com" }, "translatedUrl": { "cacheKeyHostname": "new-origin-www.example.com.akadns.net", "cpCode": 1234567, "serialNumber": "16382", "ttl": "Infinite", "typeCode": " Object changes when ARL changes" } }, "schema": { "additionalProperties": false, "description": "Specifies the requested [ARL](https://techdocs.akamai.com/edge-diagnostics/docs/arl-syntax) and details about the request.", "type": "object", "required": [ "request", "translatedUrl" ], "properties": { "request": { "additionalProperties": false, "description": "Specifies your request.", "type": "object", "required": [ "url" ], "properties": { "url": { "description": "Fully qualified [Akamaized URL](https://techdocs.akamai.com/edge-diagnostics/docs/arl-syntax) you want to get the details for.", "type": "string" } }, "x-akamai": { "file-path": "schemas/ArlRequest.yaml" } }, "translatedUrl": { "additionalProperties": false, "description": "Provides [ARL](https://techdocs.akamai.com/edge-diagnostics/docs/arl-syntax) details.", "minProperties": 1, "type": "object", "properties": { "cacheControl": { "description": "Cache control.", "minLength": 1, "type": "string" }, "cacheKeyHostname": { "description": "Cache key hostname.", "format": "hostname", "type": "string" }, "cpCode": { "description": "CP code that applies to the requested URL.", "minimum": 1, "type": "integer" }, "pragma": { "description": "Pragma header.", "minLength": 1, "nullable": true, "type": "string" }, "serialNumber": { "description": "Unique identifier for a server mapped to a region.", "minLength": 1, "type": "string" }, "ttl": { "description": "Remaining time to live in cache, either the number of seconds or `Infinite`.", "minLength": 1, "type": "string" }, "typeCode": { "description": "Description of the server configuration.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/ArlOutput.yaml" } } }, "x-akamai": { "file-path": "schemas/ArlContainer.yaml" } } } }, "headers": { "X-RateLimit-Limit": { "description": "The rate limit ceiling for this endpoint.", "example": 10, "schema": { "type": "integer" }, "x-akamai": { "file-path": "headers/X-RateLimit-Limit.yaml" } }, "X-RateLimit-Remaining": { "description": "The number of requests left for the time window.", "example": 5, "schema": { "type": "integer" }, "x-akamai": { "file-path": "headers/X-RateLimit-Remaining.yaml" } } } }, "400": { "description": "[Validation error](https://techdocs.akamai.com/edge-diagnostics/reference/400).", "content": { "application/problem+json": { "example": { "detail": "Provide only one of these members, either `edgeLocationId` or `edgeIp`.", "status": 400, "title": "Incorrect request.", "type": "bad.request.error", "errors": [ { "requestField": "edgeLocationId", "title": "Conflicting values.", "type": "field.conflict" }, { "requestField": "edgeIp", "title": "Conflicting values.", "type": "field.conflict" } ] }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/400.yaml" } }, "401": { "description": "[Authorization error](https://techdocs.akamai.com/edge-diagnostics/reference/401).", "content": { "application/problem+json": { "example": { "detail": "Inactive client token", "instance": "https://akab-nedrvuylepskzabx-lv3dgceqqktx3i5b.luna.akamaiapis.net/edge-diagnostics/v1/grep/requests", "status": 401, "title": "Not authorized", "type": "https://problems.luna.akamaiapis.net/-/pep-authn/deny" }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/401.yaml" } }, "403": { "description": "[Permission error](https://techdocs.akamai.com/edge-diagnostics/reference/403).", "content": { "application/problem+json": { "example": { "status": 403, "title": "Forbidden request.", "type": "forbidden.request.error", "errors": [ { "detail": "You don't have access to the requested URL. Contact your Admin to request access.", "requestField": "url", "title": "Field access denied.", "type": "field.access.denied" } ] }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/403.yaml" } }, "405": { "description": "[Method not allowed](https://techdocs.akamai.com/edge-diagnostics/reference/405).", "content": { "application/problem+json": { "example": { "title": "Method not allowed", "type": "method.not.allowed" }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/405.yaml" } }, "429": { "description": "[Too many requests](https://techdocs.akamai.com/edge-diagnostics/reference/429).", "content": { "application/problem+json": { "example": { "detail": "You have exceeded total number of requests configured for this API.", "status": 429, "title": "Too Many Requests", "type": "requests.exceeded.error" }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/429.yaml" } } }, "parameters": [ { "description": "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ] } }, "/url-health-check": { "post": { "description": "Launches an [asynchronous](https://techdocs.akamai.com/edge-diagnostics/reference/asynchronous-processes) request to simultaneously run [Launch a GREP request](https://techdocs.akamai.com/edge-diagnostics/reference/post-grep), [Get domain details with dig](https://techdocs.akamai.com/edge-diagnostics/reference/post-dig), [Request content with cURL](https://techdocs.akamai.com/edge-diagnostics/reference/post-curl), [Test network connectivity with MTR](https://techdocs.akamai.com/edge-diagnostics/reference/post-mtr) and [Translate an Akamaized URL](https://techdocs.akamai.com/edge-diagnostics/reference/post-translated-url) operations for a URL. Successful operations return fetched GREP, dig, cURL, and MTR data and [Akamaized URL (ARL)](https://techdocs.akamai.com/edge-diagnostics/docs/arl-syntax) details.", "operationId": "post-url-health-check", "summary": "Run the URL health check", "tags": [ "URL Health Check" ], "externalDocs": { "description": "See documentation for this operation in Akamai's Edge Diagnostics API", "url": "https://techdocs.akamai.com/edge-diagnostics/reference/post-url-health-check" }, "requestBody": { "required": true, "content": { "application/json": { "example": { "edgeLocationId": "allen-tx-unitedregionCodes", "ipVersion": "IPV4", "packetType": "TCP", "port": 80, "queryType": "A", "spoofEdgeIp": "192.0.2.9", "url": "http://www.atcuser15.akamaiu.com", "requestHeaders": [ "Accept-Language: en-US" ], "viewsAllowed": [ "CONNECTIVITY", "LOGS" ] }, "schema": { "additionalProperties": false, "description": "Collects data to use in the URL health check request.", "type": "object", "required": [ "url" ], "properties": { "edgeLocationId": { "description": "Unique identifier for an edge server location closest to your end users. Run the [List available edge server locations](https://techdocs.akamai.com/edge-diagnostics/reference/get-edge-locations) operation to get this value.", "example": "{{edgeLocationId}}", "minLength": 1, "type": "string" }, "ipVersion": { "description": "IP version for the URL health check to use to run cURL and MTR, either `IPV4` or `IPV6`.", "example": "{{ipVersion}}", "type": "string", "enum": [ "IPV4", "IPV6" ] }, "packetType": { "description": "Packet type for the URL health check to use to run MTR, either `ICMP` or `TCP`. Provide it only for requests with `CONNECTIVITY` in the `viewsAllowed` array.", "example": "{{packetType}}", "type": "string", "enum": [ "ICMP", "TCP" ] }, "port": { "description": "Port number for the URL health check to use to run MTR, either `80` or `443`. Provide it only for requests with `CONNECTIVITY` in the `viewsAllowed` array.", "example": "{{port}}", "type": "integer", "enum": [ 80, 443 ] }, "queryType": { "description": "DNS query type you want to get the records of with the DIG command. Possible values are: `A`, `AAAA`, `SOA`, `CNAME`, `PTR`, `MX`, `NS`, `TXT`, `SRV`, `CAA`, and `ANY`. To learn more about them, check [Supported DNS record types](https://techdocs.akamai.com/edge-diagnostics/docs/domain-details-dig#supported-dns-record-types).", "example": "{{queryType}}", "type": "string", "enum": [ "A", "SOA", "CNAME", "PTR", "MX", "AAAA", "NS", "TXT", "SRV", "CAA", "ANY" ] }, "requestHeaders": { "description": "Customized headers for the `curl` request in the format `header: value`. The request includes [Akamai Pragma headers](https://techdocs.akamai.com/edge-diagnostics/docs/pragma-headers) by default.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } }, "runFromSiteShield": { "description": "Runs a URL health check from a Site Shield map. To learn more, check [Site Shield requests](https://techdocs.akamai.com/edge-diagnostics/reference/site-shield-requests).", "example": "{{runFromSiteShield}}", "type": "boolean" }, "sensitiveRequestHeaderKeys": { "description": "Sensitive `requestHeaders` you don't want to store in the database after running the request. Check [Sensitive headers](https://techdocs.akamai.com/edge-diagnostics/reference/sensitive-headers) to see the list of request headers treated as sensitive by default.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } }, "spoofEdgeIp": { "description": "IP of the edge server you want to serve traffic from. You can use the edge server IP value from the `answerSection` array in the [Get domain details with dig](https://techdocs.akamai.com/edge-diagnostics/reference/post-dig) operation response.", "example": "{{spoofEdgeIp}}", "minLength": 1, "type": "string" }, "url": { "description": "URL you want to run the health check for.", "example": "{{url}}", "minLength": 1, "type": "string" }, "viewsAllowed": { "description": "Additional operations for the URL health check to run. `CONNECTIVITY` runs the [Test network connectivity with MTR](https://techdocs.akamai.com/edge-diagnostics/reference/post-mtr) operation and `LOGS` runs the [Get specific logs](https://techdocs.akamai.com/edge-diagnostics/reference/get-grep) operation.", "minItems": 0, "type": "array", "items": { "type": "string", "enum": [ "CONNECTIVITY", "LOGS" ] } } }, "x-akamai": { "file-path": "schemas/urlHealthCheckRequest.yaml" } } } } }, "responses": { "202": { "description": "Process successfully launched.", "content": { "application/json": { "example": { "createdBy": "alfulani", "createdTime": "2021-09-29T05:07:30Z", "executionStatus": "SUCCESS", "internalIp": "192.0.2.5", "requestId": 365, "internalIpLocation": { "asNumber": 20940, "city": "ASHBURN", "countryCode": "US", "regionCode": "VA" }, "request": { "edgeLocationId": "allen-tx-unitedregionCodes", "ipVersion": "IPV6", "packetType": "TCP", "port": 80, "queryType": "A", "spoofEdgeIp": "192.0.2.9", "url": "http://www.atcuser15.akamaiu.com", "viewsAllowed": [ "CONNECTIVITY", "LOGS" ] }, "spoofEdgeIpLocation": { "asNumber": 20940, "city": "MUMBAI", "countryCode": "IN", "regionCode": "MH" }, "summary": { "cacheKeyHostname": "www.example.com", "cacheSetting": "TCP_MISS", "cpCode": 1234567, "edgeServerIp": "192.0.2.5", "edgeStatusCode": "200", "originResponseCode": "200", "originServerHostname": "www.example.com", "originServerIp": "2001:db8:788d:f50c:2f6a:5cae:f61a:2e94", "serialNumber": "1580", "ttl": "Infinite", "typeCode": " Object changes when ARL changes", "connectivity": [ { "destinationContext": "ORIGIN_IP", "executionContext": "EDGE_IP_TO_ORIGIN_IP", "executionStatus": "SUCCESS", "sourceContext": "EDGE_IP_CONNECTED_TO_ORIGIN", "suggestedActions": [ "Look for a packet loss or sudden jumps in the hop time.", "For a loss or latency within the end user ISP network, ask the end user to contact thier ISP.", "For a loss or latency within Akamai network, contact Akamai Technical Support.", "If a packet loss occurs at one hop but does not propogate to the end of the trace, it is irrelevant." ], "additionalRequestParameters": { "destination": "2001:db8:8098:a0bd:6cf7:c696:8102:17a9", "source": "192.0.2.14" }, "destinationIpLocation": { "asNumber": 20940, "city": "ASHBURN", "countryCode": "US", "regionCode": "VA" }, "result": { "host": "a23-212-50-38.deploy.akamaitechnologies.com", "hops": [ { "averageLatency": 0, "bestRtt": 0, "host": "???", "lastPacketLatency": 0, "number": 12, "packetLoss": 100, "sentPackets": 10, "standardDeviation": 0, "worstRtt": 0 }, { "averageLatency": 0, "bestRtt": 0, "host": "???", "lastPacketLatency": 0, "number": 1, "packetLoss": 100, "sentPackets": 10, "standardDeviation": 0, "worstRtt": 0 } ] }, "sourceIpLocation": { "asNumber": 20940, "city": "MUMBAI", "countryCode": "IN", "regionCode": "MH" } } ], "content": [ { "executionContext": "DEFAULT", "executionStatus": "SUCCESS", "suggestedActions": [ "Compare the response headers served from edge and origin.", "Check for content correctness.", "Check content length/bytes served." ], "additionalRequestParameters": { "requestHeaders": [ "Pragma: akamai-x-cache-on, akamai-x-cache-remote-on, akamai-x-check-cacheable, akamai-x-get-true-cache-key, akamai-x-get-cache-key, akamai-x-serial-no, akamai-x-get-request-id" ] }, "result": { "responseHeaderList": [ "Last-Modified: Thu, 12 Feb 2015 15:44:28 GMT", "Content-Length: 15051" ] } } ], "domainDetails": [ { "executionContext": "DEFAULT", "executionStatus": "SUCCESS", "result": { "answerSection": [ { "hostname": "www.atcuser15.akamaiu.com.", "recordClass": "IN", "recordType": "CNAME", "ttl": 82108, "value": "www.example.com.edgesuite.net." }, { "hostname": "a1580.dscr.akamai.net.", "recordClass": "IN", "recordType": "A", "ttl": 20, "value": "192.0.2.99" } ] } } ], "logLines": [ { "executionContext": "DEFAULT", "executionStatus": "SUCCESS", "suggestedActions": [ "Check for long times.", "Check content length/bytes served." ], "result": { "legend": { "fObjectStatus": { "D": "A default object was served.", "a": "This response was sent through the ESI processor.", "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." }, "fObjectStatus2": {}, "fObjectStatus3": {}, "logType": { "f": "(f) going forward to forward hostname" }, "rObjectStatus": {}, "rObjectStatus2": {}, "rObjectStatus3": {} }, "logs": [ { "clientIp": "192.0.2.5", "contentBytesServed": "-", "edgeIp": "192.0.2.14", "forwardIp": "192.0.2.15", "logType": "f", "objectStatus": "oaDx", "timeTaken": "0", "turnaroundTime": "266" } ] } } ] }, "connectivity": [ { "destinationContext": "ORIGIN_IP", "executionContext": "EDGE_IP_TO_ORIGIN_IP", "executionStatus": "SUCCESS", "sourceContext": "EDGE_IP_CONNECTED_TO_ORIGIN", "suggestedActions": [ "Look for a packet loss or sudden jumps in the hop time.", "For a loss or latency within the end user ISP network, ask the end user to contact thier ISP.", "For a loss or latency within Akamai network, contact Akamai Technical Support.", "If a packet loss occurs at one hop but does not propogate to the end of the trace, it is irrelevant.", "If source Ip country and destination IP country is same then there should not be any hops outside the country." ], "additionalRequestParameters": { "destination": "2001:db8:1f8d:ecba:b096:8717:4c08:7e69", "source": "192.0.2.14" }, "destinationIpLocation": { "asNumber": 20940, "city": "ASHBURN", "countryCode": "US", "regionCode": "VA" }, "result": { "averageLatency": 204.1, "host": "a23-212-50-38.deploy.akamaitechnologies.com", "packetLoss": 0, "result": "Start: 2021-09-29T05:08:20+0000\nHOST: a23-212-50-38.deploy.akamaitechnologies.com Loss% Snt Last Avg Best Wrst StDev\n 1.|-- ??? 100.0 10 0.0 0.0 0.0 0.0 0.0\n 2.|-- 2403:0:100::911 0.0% 10 0.4 0.4 0.3 0.5 0.1\n 3.|-- if-ae-1-101.tcore2.mlv-mumbai.ipv6.as6453.net (2001:db8::c) 0.0% 10 8.4 2.5 0.4 10.3 3.7\n 4.|-- if-ae-12-2.tcore1.l78-london.ipv6.as6453.net (2001:db8::d) 0.0% 10 128.3 138.9 125.2 216.0 28.0\n 5.|-- if-ae-15-2.tcore3.njy-newark.ipv6.as6453.net (2001:db8::e) 0.0% 10 196.7 198.9 195.0 210.5 4.5\n 6.|-- if-ae-1-3.tcore4.njy-newark.ipv6.as6453.net (2001:db8::b) 0.0% 10 199.4 199.6 196.6 201.4 1.4\n 7.|-- if-ae-12-2.tcore3.aeq-ashburn.ipv6.as6453.net (2001:db8::b) 0.0% 10 206.5 206.4 204.3 216.0 3.5\n 8.|-- 2001:5a0:600:502::2 0.0% 10 204.4 204.5 201.9 206.6 1.6\n 9.|-- ae1.r01.iad01.icn.netarch.akamai.com (2600:1488:a180:125::a) 0.0% 10 205.1 205.7 200.4 209.4 2.3\n 10.|-- ae3.r01.iad03.icn.netarch.akamai.com (2600:1488:5fc3:4d::b) 0.0% 10 206.6 205.1 200.2 214.0 4.3\n 11.|-- ae5.r01.iad03.ien.netarch.akamai.com (2600:1488:a181:111::b) 0.0% 10 205.2 205.2 196.3 219.4 6.0\n 12.|-- ??? 100.0 10 0.0 0.0 0.0 0.0 0.0\n 13.|-- g2600-1408-7400-0000-0000-0000-17c7-3f1b.deploy.static.akamaitechnologies.com (2 0.0% 10 200.7 204.1 200.3 205.9 2.0", "startTime": 1632892100, "hops": [ { "averageLatency": 0, "bestRtt": 0, "host": "???", "lastPacketLatency": 0, "number": 1, "packetLoss": 100, "sentPackets": 10, "standardDeviation": 0, "worstRtt": 0 }, { "averageLatency": 204.1, "bestRtt": 200.3, "host": "g2600-1408-7400-0000-0000-0000-17c7-3f1b.deploy.static.akamaitechnologies.com", "lastPacketLatency": 200.7, "number": 2, "packetLoss": 0, "sentPackets": 10, "standardDeviation": 2, "worstRtt": 205.9 } ] }, "sourceIpLocation": { "asNumber": 20940, "city": "MUMBAI", "countryCode": "IN", "regionCode": "MH" } } ], "content": [ { "executionContext": "DEFAULT", "executionStatus": "SUCCESS", "suggestedActions": [ "Compare the response headers served from edge and origin.", "Check for content correctness.", "Check content length/bytes served." ], "additionalRequestParameters": { "requestHeaders": [ "Pragma: akamai-x-cache-on, akamai-x-cache-remote-on, akamai-x-check-cacheable, akamai-x-get-true-cache-key, akamai-x-get-cache-key, akamai-x-serial-no, akamai-x-get-request-id" ] }, "result": { "httpStatusCode": 200, "httpVersion": "HTTP/1.1", "reasonPhrase": "OK", "responseHeaderList": [ "X-Cache: TCP_MISS from a23-212-50-38.deploy.akamaitechnologies.com (AkamaiGHost/10.4.4-34537092) (-)", "X-True-Cache-Key: /D/000/akamaiflowershop.com/ vcd=1456", "Server: Apache/2.4.7 (Ubuntu)", "Content-Length: 15051", "Content-Type: text/html" ], "timing": { "dnsLookupTime": 1.509502, "sslConnectionTime": 0, "tcpConnectionTime": 1.524193, "timeToFirstByte": 1.555875, "totalTime": 2.091051 } } } ], "domainDetails": [ { "executionContext": "DEFAULT", "executionStatus": "SUCCESS", "result": { "result": "\n; <<>> DiG 9.11.3-1ubuntu1.14aka10.0.8-Ubuntu <<>> www.atcuser15.akamaiu.com -t A\n;; global options: +cmd\n;; Got answer:\n;; ->>HEADER<<- opcode: QUERY, status: NOERROR, id: 27583\n;; flags: qr rd ra; QUERY: 1, ANSWER: 4, AUTHORITY: 0, ADDITIONAL: 1\n\n;; OPT PSEUDOSECTION:\n; EDNS: version: 0, flags:; udp: 4096\n; COOKIE: 5ed2048bbeaf4087d1154fba6153f49926837baa0b15243d (good)\n;; QUESTION SECTION:\n;www.atcuser15.akamaiu.com.\tIN\tA\n\n;; ANSWER SECTION:\nwww.atcuser15.akamaiu.com. 82108 IN\tCNAME\twww.example.com.edgesuite.net.\nwww.example.com.edgesuite.net. 17308 IN CNAME\ta1580.dscr.akamai.net.\na1580.dscr.akamai.net.\t20\tIN\tA\t23.50.51.203\na1580.dscr.akamai.net.\t20\tIN\tA\t23.50.51.240\n\n;; Query time: 1 msec\n;; SERVER: 127.0.0.1#53(127.0.0.1)\n;; WHEN: Wed Sep 29 05:07:37 UTC 2021\n;; MSG SIZE rcvd: 202\n", "answerSection": [ { "hostname": "www.atcuser15.akamaiu.com.", "recordClass": "IN", "recordType": "CNAME", "ttl": 82108, "value": "www.example.com.edgesuite.net." }, { "hostname": "a1580.dscr.akamai.net.", "recordClass": "IN", "recordType": "A", "ttl": 20, "value": "192.0.2.198" } ] } } ], "logLines": [ { "executionContext": "DEFAULT", "executionStatus": "SUCCESS", "suggestedActions": [ "Check for long times.", "Check content length/bytes served." ], "result": { "legend": { "fObjectStatus": { "D": "A default object was served.", "a": "This response was sent through the ESI processor.", "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." }, "fObjectStatus2": {}, "fObjectStatus3": {}, "logType": { "f": "(f) going forward to forward hostname" }, "rObjectStatus": {}, "rObjectStatus2": {}, "rObjectStatus3": {} }, "logs": [ { "arl": "/D/1580/1234567/000/akamaiflowershop.com/", "bytesReceived": "3980", "bytesServed": "-", "clientIp": "192.0.2.5", "contentBytesServed": "-", "contentType": "text/html", "cookie": "-", "cpCode": "1234567", "dateTime": "2021-09-29T05:07:44.733Z", "edgeIp": "192.0.2.14", "error": "-", "forwardIp": "192.0.2.15", "hostHeader": "-", "httpMethod": "GET", "httpStatus": "200", "logType": "f", "objectSize": "-", "objectStatus": "oaDx", "objectStatus2": "-", "objectStatus3": "-", "referer": "-", "sslVersion": "-", "timeTaken": "0", "turnaroundTime": "266", "userAgent": "-" } ] } } ] }, "schema": { "additionalProperties": false, "description": "Collects the URL health check results and details about the request.", "type": "object", "required": [ "summary", "content", "connectivity", "createdBy", "createdTime", "domainDetails", "executionStatus", "internalIp", "internalIpLocation", "logLines", "request", "requestId" ], "properties": { "connectivity": { "description": "Lists the results of the MTR request. Shows only if the request included `CONNECTIVITY` in the `viewsAllowed` array.", "minItems": 0, "type": "array", "items": { "additionalProperties": false, "type": "object", "required": [ "executionStatus", "sourceIpLocation", "destinationIpLocation", "sourceContext", "destinationContext", "executionContext" ], "properties": { "additionalRequestParameters": { "additionalProperties": false, "description": "Specifies the MTR request.", "minProperties": 1, "type": "object", "required": [ "source", "destination" ], "properties": { "destination": { "description": "Destination of the request.", "minLength": 1, "type": "string" }, "ipVersion": { "description": "IP version used by the request, either `IPV4` or `IPV6`.", "type": "string", "enum": [ "IPV4", "IPV6" ] }, "packetType": { "description": "Packet type used by the request, either `ICMP` or `TCP`.", "type": "string", "enum": [ "ICMP", "TCP" ] }, "port": { "description": "Port number used by the request, either `80` or `443`.", "type": "integer", "enum": [ 80, 443 ] }, "source": { "description": "Source of the request.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/additionalMtrRequestParameters.yaml" } }, "destinationContext": { "description": "Whether the destination IP is a `CLIENT_IP` or `ORIGIN_IP`.", "type": "string", "enum": [ "ORIGIN_IP", "CLIENT_IP" ] }, "destinationIpLocation": { "additionalProperties": false, "description": "Specifies the geolocation of the origin server IP.", "type": "object", "required": [ "city", "regionCode", "countryCode", "asNumber" ], "properties": { "asNumber": { "description": "Autonomous System Number the edge IP maps to.", "minimum": 0, "type": "integer" }, "city": { "description": "Closest city within a 50-mile radius the edge IP maps to.", "minLength": 1, "type": "string" }, "countryCode": { "description": "ISO 3166 country code the edge IP maps to.", "minLength": 1, "type": "string" }, "regionCode": { "description": "ISO 3166 region code the edge IP maps to.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/edgeIpLocation.yaml" } }, "errorResponse": { "additionalProperties": false, "description": "Specifies the reason for `FAILURE` status.", "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Details about the error.", "minLength": 1, "type": "string" }, "errors": { "description": "Collects information about problems occurred while fetching the data.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } }, "status": { "description": "Error status code.", "minLength": 1, "type": "string" }, "title": { "description": "Error title.", "minLength": 1, "type": "string" }, "type": { "description": "Error type.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/errorResponse.yaml" } }, "executionContext": { "description": "Execution context for MTR. Edge Diagnostics executes MTR between an edge server and the origin server (`EDGE_IP_TO_ORIGIN_IP`) or, if a client IP is present in the request, between an edge server and the client machine (`EDGE_IP_TO_CLIENT_IP`).", "type": "string", "enum": [ "EDGE_IP_TO_ORIGIN_IP", "EDGE_IP_TO_CLIENT_IP" ] }, "executionStatus": { "description": "Status of the MTR request's execution. Possible values are `SUCCESS`, `FAILURE`, or `NOT_EXECUTED`. The `info` member and `FAILURE` in `errorResponse` provide details for `NOT_EXECUTED`.", "type": "string", "enum": [ "SUCCESS", "FAILURE", "NOT_EXECUTED" ] }, "info": { "additionalProperties": false, "description": "Specifies the reason for `NOT_EXECUTED` status.", "type": "object", "required": [ "key", "message" ], "properties": { "key": { "description": "Error key.", "minLength": 1, "type": "string" }, "message": { "description": "Details about the error.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/info.yaml" } }, "result": { "additionalProperties": false, "description": "Standard MTR results.", "type": "object", "required": [ "startTime", "host", "packetLoss", "averageLatency", "hops", "result" ], "properties": { "averageLatency": { "description": "Average latency for all hops, in seconds.", "minimum": 0, "type": "number" }, "hops": { "description": "Lists network hops with their data.", "minItems": 0, "type": "array", "items": { "additionalProperties": false, "description": "Collects network hops with their data.", "type": "object", "required": [ "number", "host", "ip", "ipLocation", "packetLoss", "sentPackets", "lastPacketLatency", "averageLatency", "bestRtt", "worstRtt", "standardDeviation" ], "properties": { "averageLatency": { "description": "Average hop value, useful to detect ongoing problems.", "minimum": 0, "type": "number" }, "bestRtt": { "description": "Fastest time, in milliseconds.", "minimum": 0, "type": "number" }, "host": { "description": "Host or domain name for the hop.", "minLength": 1, "type": "string" }, "ip": { "description": "IP of the hop's `edgeHost`.", "minLength": 1, "type": "string" }, "ipLocation": { "additionalProperties": false, "description": "Geolocation data for the hop's `edgeHost`.", "type": "object", "required": [ "city", "regionCode", "countryCode", "asNumber" ], "properties": { "asNumber": { "description": "Autonomous System Number the edge IP maps to.", "minimum": 0, "type": "integer" }, "city": { "description": "Closest city within a 50-mile radius the edge IP maps to.", "minLength": 1, "type": "string" }, "countryCode": { "description": "ISO 3166 country code the edge IP maps to.", "minLength": 1, "type": "string" }, "regionCode": { "description": "ISO 3166 region code the edge IP maps to.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/edgeIpLocation.yaml" } }, "lastPacketLatency": { "description": "Last measured hop value, useful to detect ongoing problems.", "minimum": 0, "type": "number" }, "number": { "description": "Index for each hop's count within the full set.", "minimum": 0, "type": "integer" }, "packetLoss": { "description": "Percentage of packets lost for the hop, maximum `100`.", "maximum": 100, "minimum": 0, "type": "number" }, "sentPackets": { "description": "Number of packets sent for the hop.", "minimum": 0, "type": "integer" }, "standardDeviation": { "description": "Standard deviation, in milliseconds.", "minimum": 0, "type": "number" }, "worstRtt": { "description": "Slowest time, in milliseconds.", "minimum": 0, "type": "number" } }, "x-akamai": { "file-path": "schemas/mtrHopInstance.yaml" } } }, "host": { "description": "Hostname within the edge network that corresponds to the `source` IP address.", "format": "hostname", "type": "string" }, "packetLoss": { "description": "Percentage of packets lost, maximum `100`.", "maximum": 100, "minimum": 0, "type": "number" }, "result": { "description": "Raw MTR utility output.", "minLength": 1, "type": "string" }, "startTime": { "description": "Epoch timestamp marking when MTR was run.", "type": "integer" } }, "x-akamai": { "file-path": "schemas/mtrData.yaml" } }, "sourceContext": { "description": "Context for MTR source. The source can be either an edge server forwarding the request to the origin server (`EDGE_IP_CONNECTED_TO_ORIGIN`) or an edge server in the location (`EDGE_IP_BASED_ON_LOCATION`), either selected randomly or provided in the request.", "type": "string", "enum": [ "EDGE_IP_CONNECTED_TO_ORIGIN", "EDGE_IP_BASED_ON_LOCATION" ] }, "sourceIpLocation": { "additionalProperties": false, "description": "Specifies the geolocation of the source IP.", "type": "object", "required": [ "city", "regionCode", "countryCode", "asNumber" ], "properties": { "asNumber": { "description": "Autonomous System Number the edge IP maps to.", "minimum": 0, "type": "integer" }, "city": { "description": "Closest city within a 50-mile radius the edge IP maps to.", "minLength": 1, "type": "string" }, "countryCode": { "description": "ISO 3166 country code the edge IP maps to.", "minLength": 1, "type": "string" }, "regionCode": { "description": "ISO 3166 region code the edge IP maps to.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/edgeIpLocation.yaml" } }, "suggestedActions": { "description": "Suggestions on what to do next with the results.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } } }, "x-akamai": { "file-path": "schemas/connectivity.yaml" } } }, "content": { "description": "Lists the results of the cURL request.", "minItems": 0, "type": "array", "items": { "additionalProperties": false, "type": "object", "required": [ "executionContext", "executionStatus" ], "properties": { "additionalRequestParameters": { "additionalProperties": false, "description": "Specifies the cURL request.", "minProperties": 1, "type": "object", "properties": { "includeDefaultPragmaHeaders": { "description": "Indicates whether the request included the default list of `Pragma` headers. Check [Pragma headers](https://techdocs.akamai.com/edge-diagnostics/docs/pragma-headers) to learn about default Akamai Pragma headers.", "type": "boolean" }, "ipVersion": { "description": "IP version used by the request, either `IPV4` or `IPV6`.", "type": "string", "enum": [ "IPV4", "IPV6" ] }, "requestHeaders": { "description": "Customized headers for `curl` request in the format `header: value`.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } } }, "x-akamai": { "file-path": "schemas/additionalCurlRequestParameters.yaml" } }, "errorResponse": { "additionalProperties": false, "description": "Specifies the reason for `FAILURE` status.", "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Details about the error.", "minLength": 1, "type": "string" }, "errors": { "description": "Collects information about problems occurred while fetching the data.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } }, "status": { "description": "Error status code.", "minLength": 1, "type": "string" }, "title": { "description": "Error title.", "minLength": 1, "type": "string" }, "type": { "description": "Error type.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/errorResponse.yaml" } }, "executionContext": { "description": "Execution context. The only possible value is `DEFAULT`. For now, this member doesn't provide any meaningful data.", "type": "string", "enum": [ "DEFAULT" ] }, "executionStatus": { "description": "Status of the cURL request's execution, either `SUCCESS` or `FAILURE`.", "type": "string", "enum": [ "SUCCESS", "FAILURE" ] }, "result": { "additionalProperties": false, "description": "Results of the `curl` command.", "minProperties": 1, "type": "object", "required": [ "exitCode" ], "properties": { "exitCode": { "description": "Curl command exit code. [List of possible curl exit code.](https://curl.se/libcurl/c/libcurl-errors.html) ", "minimum": 0, "type": "integer" }, "httpStatusCode": { "description": "Returned HTTP response code.", "maximum": 599, "minimum": 100, "type": "integer" }, "httpVersion": { "description": "HTTP version used for `curl`.", "minLength": 1, "type": "string" }, "reasonPhrase": { "description": "Reason phrase for the response.", "minLength": 1, "type": "string" }, "responseBody": { "description": "Entire response body.", "minLength": 1, "type": "string" }, "responseHeaderList": { "description": "Collects the response headers in the format `header: value`.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } }, "timing": { "additionalProperties": false, "description": "Collects the time related data.", "type": "object", "required": [ "dnsLookupTime", "tcpConnectionTime", "sslConnectionTime", "timeToFirstByte", "totalTime" ], "properties": { "dnsLookupTime": { "description": "DNS lookup time, in seconds.", "minimum": 0, "type": "number" }, "sslConnectionTime": { "description": "SSL connection time, in seconds.", "minimum": 0, "type": "number" }, "tcpConnectionTime": { "description": "TCP connection time, in seconds.", "minimum": 0, "type": "number" }, "timeToFirstByte": { "description": "Time to first byte, in seconds.", "minimum": 0, "type": "number" }, "totalTime": { "description": "Total time, in seconds.", "minimum": 0, "type": "number" } } } }, "x-akamai": { "file-path": "schemas/curlResults.yaml" } }, "suggestedActions": { "description": "Suggestions on what to do next with the results.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } } }, "x-akamai": { "file-path": "schemas/contentDetail.yaml" } } }, "createdBy": { "description": "Username who submitted the request.", "minLength": 1, "type": "string" }, "createdTime": { "description": "ISO 8601 timestamp indicating when the request was submitted.", "format": "date-time", "type": "string" }, "domainDetails": { "description": "Lists the results of the DIG request.", "minItems": 0, "type": "array", "items": { "additionalProperties": false, "type": "object", "required": [ "executionStatus" ], "properties": { "additionalRequestParameters": { "additionalProperties": false, "description": "Specifies the DIG request.", "minProperties": 1, "type": "object", "properties": { "queryType": { "description": "DNS query type fetched by the request. Possible values are: `A`, `AAAA`, `SOA`, `CNAME`, `PTR`, `MX`, `NS`, `TXT`, `SRV`, `CAA`, and `ANY`. To learn more about them, check [Supported DNS record types](https://techdocs.akamai.com/edge-diagnostics/docs/domain-details-dig#supported-dns-record-types).", "type": "string", "enum": [ "A", "SOA", "CNAME", "PTR", "MX", "AAAA", "NS", "TXT", "SRV", "CAA", "ANY" ] } }, "x-akamai": { "file-path": "schemas/additionalDigRequestParameters.yaml" } }, "errorResponse": { "additionalProperties": false, "description": "Specifies the reason for `FAILURE` status.", "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Details about the error.", "minLength": 1, "type": "string" }, "errors": { "description": "Collects information about problems occurred while fetching the data.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } }, "status": { "description": "Error status code.", "minLength": 1, "type": "string" }, "title": { "description": "Error title.", "minLength": 1, "type": "string" }, "type": { "description": "Error type.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/errorResponse.yaml" } }, "executionContext": { "description": "Execution context. The only possible value is `DEFAULT`. For now, this member doesn't provide any meaningful data.", "type": "string", "enum": [ "DEFAULT" ] }, "executionStatus": { "description": "Status of the DIG request's execution, either `SUCCESS` or `FAILURE`.", "type": "string", "enum": [ "SUCCESS", "FAILURE" ] }, "result": { "additionalProperties": false, "description": "Standard `dig` response.", "type": "object", "required": [ "result" ], "properties": { "answerSection": { "description": "Collects a DNS record of answering servers.", "minItems": 1, "type": "array", "items": { "additionalProperties": false, "description": "Specifies a DNS record that appears within a response of the [Get domain details with dig](https://techdocs.akamai.com/edge-diagnostics/reference/post-dig) operation, in `answerSection` or `authoritySection`.", "type": "object", "properties": { "domain": { "description": "Domain name for this record.", "minLength": 1, "type": "string" }, "hostname": { "description": "Hostname you requested the data for.", "format": "hostname", "type": "string" }, "preferenceValue": { "description": "Preference value, only valid for records of the `MX` type, otherwise `null`.", "minimum": 0, "nullable": true, "type": "integer" }, "recordClass": { "description": "Class of the record, typically `IN` for *internet*.", "minLength": 1, "type": "string" }, "recordType": { "description": "Requested record type. Possible values are: `A`, `AAAA`, `SOA`, `CNAME`, `PTR`, `MX`, `NS`, `TXT`, `SRV`, `CAA`, and `ANY`. To learn more about them, check [Supported DNS record types](https://techdocs.akamai.com/edge-diagnostics/docs/domain-details-dig#supported-dns-record-types).", "type": "string", "enum": [ "A", "AAAA", "SOA", "CNAME", "PTR", "MX", "NS", "TXT", "SRV", "CAA", "ANY" ] }, "ttl": { "description": "Server's default number of seconds to keep content cached.", "minimum": 0, "type": "integer" }, "value": { "description": "Record's value, either another domain or a final IP address.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/dnsRecord.yaml" }, "oneOf": [ { "title": "Hostname required", "required": [ "hostname", "ttl", "recordClass", "recordType", "value" ] }, { "title": "Domain required", "required": [ "domain", "ttl", "recordClass", "recordType", "value" ] } ] } }, "authoritySection": { "description": "Collects a DNS record of servers authorized to answer.", "minItems": 1, "type": "array", "items": { "additionalProperties": false, "description": "Specifies a DNS record that appears within a response of the [Get domain details with dig](https://techdocs.akamai.com/edge-diagnostics/reference/post-dig) operation, in `answerSection` or `authoritySection`.", "type": "object", "properties": { "domain": { "description": "Domain name for this record.", "minLength": 1, "type": "string" }, "hostname": { "description": "Hostname you requested the data for.", "format": "hostname", "type": "string" }, "preferenceValue": { "description": "Preference value, only valid for records of the `MX` type, otherwise `null`.", "minimum": 0, "nullable": true, "type": "integer" }, "recordClass": { "description": "Class of the record, typically `IN` for *internet*.", "minLength": 1, "type": "string" }, "recordType": { "description": "Requested record type. Possible values are: `A`, `AAAA`, `SOA`, `CNAME`, `PTR`, `MX`, `NS`, `TXT`, `SRV`, `CAA`, and `ANY`. To learn more about them, check [Supported DNS record types](https://techdocs.akamai.com/edge-diagnostics/docs/domain-details-dig#supported-dns-record-types).", "type": "string", "enum": [ "A", "AAAA", "SOA", "CNAME", "PTR", "MX", "NS", "TXT", "SRV", "CAA", "ANY" ] }, "ttl": { "description": "Server's default number of seconds to keep content cached.", "minimum": 0, "type": "integer" }, "value": { "description": "Record's value, either another domain or a final IP address.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/dnsRecord.yaml" }, "oneOf": [ { "title": "Hostname required", "required": [ "hostname", "ttl", "recordClass", "recordType", "value" ] }, { "title": "Domain required", "required": [ "domain", "ttl", "recordClass", "recordType", "value" ] } ] } }, "result": { "description": "Raw `dig` output.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/digInfo.yaml" } }, "suggestedActions": { "description": "Suggestions on what to do next with the results.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } } }, "x-akamai": { "file-path": "schemas/domainDetail.yaml" } } }, "errorResponse": { "additionalProperties": false, "description": "Specifies the reason for `FAILURE` status.", "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Details about the error.", "minLength": 1, "type": "string" }, "errors": { "description": "Collects information about problems occurred while fetching the data.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } }, "status": { "description": "Error status code.", "minLength": 1, "type": "string" }, "title": { "description": "Error title.", "minLength": 1, "type": "string" }, "type": { "description": "Error type.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/errorResponse.yaml" } }, "executionStatus": { "description": "Status of the request's execution. Possible values are: `SUCCESS`, `FAILURE`, or `IN_PROGRESS`.", "type": "string", "enum": [ "SUCCESS", "FAILURE", "IN_PROGRESS" ] }, "internalIp": { "description": "Machine IP for the requested location used to forward the request to the origin server.", "minLength": 1, "type": "string" }, "internalIpLocation": { "additionalProperties": false, "description": "Specifies the geolocation of `internalIp`.", "type": "object", "required": [ "city", "regionCode", "countryCode", "asNumber" ], "properties": { "asNumber": { "description": "Autonomous System Number the edge IP maps to.", "minimum": 0, "type": "integer" }, "city": { "description": "Closest city within a 50-mile radius the edge IP maps to.", "minLength": 1, "type": "string" }, "countryCode": { "description": "ISO 3166 country code the edge IP maps to.", "minLength": 1, "type": "string" }, "regionCode": { "description": "ISO 3166 region code the edge IP maps to.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/edgeIpLocation.yaml" } }, "link": { "description": "Link to get the URL health check response after the `retryAfter` interval passes. It occurs only for operations with the `IN_PROGRESS` status.", "minLength": 1, "type": "string" }, "logLines": { "description": "Lists the results of the GREP request. Shows only if the request included `LOGS` in the `viewsAllowed` array.", "minItems": 0, "type": "array", "items": { "additionalProperties": false, "description": "Collects fetched logs.", "type": "object", "required": [ "executionContext", "executionStatus" ], "properties": { "errorResponse": { "additionalProperties": false, "description": "Specifies the reason for `FAILURE` status.", "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Details about the error.", "minLength": 1, "type": "string" }, "errors": { "description": "Collects information about problems occurred while fetching the data.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } }, "status": { "description": "Error status code.", "minLength": 1, "type": "string" }, "title": { "description": "Error title.", "minLength": 1, "type": "string" }, "type": { "description": "Error type.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/errorResponse.yaml" } }, "executionContext": { "description": "Execution context. The only possible value is `DEFAULT`. For now, this member doesn't provide any meaningful data.", "type": "string", "enum": [ "DEFAULT" ] }, "executionStatus": { "description": "Status of the GREP request's execution, either `SUCCESS` or `FAILURE`.", "type": "string", "enum": [ "SUCCESS", "FAILURE" ] }, "result": { "additionalProperties": false, "description": "Provides logs fetched with the GREP command.", "type": "object", "required": [ "logs", "legend" ], "properties": { "legend": { "additionalProperties": false, "description": "Descriptions of returned `logType`, `objectStatus`, `objectStatus2`, `objectStatus3` in `r` and `f` log lines.", "type": "object", "required": [ "logType", "rObjectStatus", "rObjectStatus2", "rObjectStatus3", "fObjectStatus", "fObjectStatus2", "fObjectStatus3" ], "properties": { "fObjectStatus": { "description": "Descriptions of the `objectStatus` data in f-line.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } }, "fObjectStatus2": { "description": "Descriptions of the `objectStatus2` data in f-line.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } }, "fObjectStatus3": { "description": "Descriptions of the `objectStatus3` data in f-line.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } }, "logType": { "description": "Description of the `logType` data.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } }, "rObjectStatus": { "description": "Descriptions of the `objectStatus` data in r-line.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } }, "rObjectStatus2": { "description": "Descriptions of the `objectStatus2` data in r-line.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } }, "rObjectStatus3": { "description": "Descriptions of the `objectStatus3` data in r-line.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } } }, "x-akamai": { "file-path": "schemas/legend.yaml" } }, "logs": { "description": "Filtered log lines.", "minItems": 0, "type": "array", "items": { "description": "Items provided as key/value pairs.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } } } }, "x-akamai": { "file-path": "schemas/logsContainer.yaml" } }, "suggestedActions": { "description": "Suggestions on what to do next with the results.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } } }, "x-akamai": { "file-path": "schemas/logLines.yaml" } } }, "request": { "additionalProperties": false, "description": "Specifies your URL health check request.", "type": "object", "required": [ "url" ], "properties": { "edgeLocationId": { "description": "Unique identifier for an edge server location closest to your end users. Run the [List available edge server locations](https://techdocs.akamai.com/edge-diagnostics/reference/get-edge-locations) operation to get this value.", "minLength": 1, "type": "string" }, "ipVersion": { "description": "IP version for the URL health check to use to run cURL and MTR, either `IPV4` or `IPV6`.", "type": "string", "enum": [ "IPV4", "IPV6" ] }, "packetType": { "description": "Packet type for the URL health check to use to run MTR, either `ICMP` or `TCP`. Provide it only for requests with `CONNECTIVITY` in the `viewsAllowed` array.", "type": "string", "enum": [ "ICMP", "TCP" ] }, "port": { "description": "Port number for the URL health check to use to run MTR, either `80` or `443`. Provide it only for requests with `CONNECTIVITY` in the `viewsAllowed` array.", "type": "integer", "enum": [ 80, 443 ] }, "queryType": { "description": "DNS query type you want to get the records of with the DIG command. Possible values are: `A`, `AAAA`, `SOA`, `CNAME`, `PTR`, `MX`, `NS`, `TXT`, `SRV`, `CAA`, and `ANY`. To learn more about them, check [Supported DNS record types](https://techdocs.akamai.com/edge-diagnostics/docs/domain-details-dig#supported-dns-record-types).", "type": "string", "enum": [ "A", "SOA", "CNAME", "PTR", "MX", "AAAA", "NS", "TXT", "SRV", "CAA", "ANY" ] }, "requestHeaders": { "description": "Customized headers for the `curl` request in the format `header: value`. The request includes [Akamai Pragma headers](https://techdocs.akamai.com/edge-diagnostics/docs/pragma-headers) by default.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } }, "runFromSiteShield": { "description": "Runs a URL health check from a Site Shield map. To learn more, check [Site Shield requests](https://techdocs.akamai.com/edge-diagnostics/reference/site-shield-requests).", "type": "boolean" }, "sensitiveRequestHeaderKeys": { "description": "Sensitive `requestHeaders` you don't want to store in the database after running the request. Check [Sensitive headers](https://techdocs.akamai.com/edge-diagnostics/reference/sensitive-headers) to see the list of request headers treated as sensitive by default.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } }, "spoofEdgeIp": { "description": "IP of the edge server you want to serve traffic from. You can use the edge server IP value from the `answerSection` array in the [Get domain details with dig](https://techdocs.akamai.com/edge-diagnostics/reference/post-dig) operation response.", "minLength": 1, "type": "string" }, "url": { "description": "URL you want to run the health check for.", "minLength": 1, "type": "string" }, "viewsAllowed": { "description": "Additional operations for the URL health check to run. `CONNECTIVITY` runs the [Test network connectivity with MTR](https://techdocs.akamai.com/edge-diagnostics/reference/post-mtr) operation and `LOGS` runs the [Get specific logs](https://techdocs.akamai.com/edge-diagnostics/reference/get-grep) operation.", "minItems": 0, "type": "array", "items": { "type": "string", "enum": [ "CONNECTIVITY", "LOGS" ] } } }, "x-akamai": { "file-path": "schemas/urlHealthCheckRequest.yaml" } }, "requestId": { "description": "Unique identifier for the URL health check request. Store this value to run [Get a URL health check response](https://techdocs.akamai.com/edge-diagnostics/reference/get-url-health-check-requests) operation.", "minimum": 0, "type": "integer" }, "retryAfter": { "description": "Number of seconds when the request is estimated to have processed. It occurs only for operations with the `IN_PROGRESS` status.", "minimum": 0, "type": "integer" }, "siteShieldIp": { "description": "If your request specifies `runFromSiteShield` as `true`, then this IP used to run a URL health check.", "minLength": 1, "type": "string" }, "siteShieldIpLocation": { "additionalProperties": false, "description": "Specifies the geolocation of the edge server used to run the operation.", "type": "object", "required": [ "city", "regionCode", "countryCode", "asNumber" ], "properties": { "asNumber": { "description": "Autonomous System Number the edge IP maps to.", "minimum": 0, "type": "integer" }, "city": { "description": "Closest city within a 50-mile radius the edge IP maps to.", "minLength": 1, "type": "string" }, "countryCode": { "description": "ISO 3166 country code the edge IP maps to.", "minLength": 1, "type": "string" }, "regionCode": { "description": "ISO 3166 region code the edge IP maps to.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/edgeIpLocation.yaml" } }, "spoofEdgeIpLocation": { "additionalProperties": false, "description": "Specifies the geolocation of the edge server used to serve the request.", "type": "object", "required": [ "city", "regionCode", "countryCode", "asNumber" ], "properties": { "asNumber": { "description": "Autonomous System Number the edge IP maps to.", "minimum": 0, "type": "integer" }, "city": { "description": "Closest city within a 50-mile radius the edge IP maps to.", "minLength": 1, "type": "string" }, "countryCode": { "description": "ISO 3166 country code the edge IP maps to.", "minLength": 1, "type": "string" }, "regionCode": { "description": "ISO 3166 region code the edge IP maps to.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/edgeIpLocation.yaml" } }, "summary": { "additionalProperties": false, "description": "Specifies [Akamaized URL (ARL)](https://techdocs.akamai.com/edge-diagnostics/docs/arl-syntax) details and partial results of the URL health check. These results contain fetched data that Edge Diagnostics identified as potential source of issues.", "type": "object", "required": [ "edgeServerIp", "content", "domainDetails", "cpCode" ], "properties": { "cacheKeyHostname": { "description": "Cache key hostname.", "format": "hostname", "type": "string" }, "cacheSetting": { "description": "Cache settings.", "minLength": 1, "type": "string" }, "connectivity": { "description": "Lists the results of the MTR request.", "minItems": 0, "type": "array", "items": { "additionalProperties": false, "type": "object", "required": [ "executionStatus", "sourceIpLocation", "destinationIpLocation", "sourceContext", "destinationContext", "executionContext" ], "properties": { "additionalRequestParameters": { "additionalProperties": false, "description": "Specifies the MTR request.", "minProperties": 1, "type": "object", "required": [ "source", "destination" ], "properties": { "destination": { "description": "Destination of the request.", "minLength": 1, "type": "string" }, "ipVersion": { "description": "IP version used by the request, either `IPV4` or `IPV6`.", "type": "string", "enum": [ "IPV4", "IPV6" ] }, "packetType": { "description": "Packet type used by the request, either `ICMP` or `TCP`.", "type": "string", "enum": [ "ICMP", "TCP" ] }, "port": { "description": "Port number used by the request, either `80` or `443`.", "type": "integer", "enum": [ 80, 443 ] }, "source": { "description": "Source of the request.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/additionalMtrRequestParameters.yaml" } }, "destinationContext": { "description": "Whether the destination IP is a `CLIENT_IP` or `ORIGIN_IP`.", "type": "string", "enum": [ "ORIGIN_IP", "CLIENT_IP" ] }, "destinationIpLocation": { "additionalProperties": false, "description": "Specifies the geolocation of the origin server IP.", "type": "object", "required": [ "city", "regionCode", "countryCode", "asNumber" ], "properties": { "asNumber": { "description": "Autonomous System Number the edge IP maps to.", "minimum": 0, "type": "integer" }, "city": { "description": "Closest city within a 50-mile radius the edge IP maps to.", "minLength": 1, "type": "string" }, "countryCode": { "description": "ISO 3166 country code the edge IP maps to.", "minLength": 1, "type": "string" }, "regionCode": { "description": "ISO 3166 region code the edge IP maps to.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/edgeIpLocation.yaml" } }, "errorResponse": { "additionalProperties": false, "description": "Specifies the reason for `FAILURE` status.", "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Details about the error.", "minLength": 1, "type": "string" }, "errors": { "description": "Collects information about problems occurred while fetching the data.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } }, "status": { "description": "Error status code.", "minLength": 1, "type": "string" }, "title": { "description": "Error title.", "minLength": 1, "type": "string" }, "type": { "description": "Error type.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/errorResponse.yaml" } }, "executionContext": { "description": "Execution context for MTR. Edge Diagnostics executes MTR between an edge server and the origin server (`EDGE_IP_TO_ORIGIN_IP`) or, if a client IP is present in the request, between an edge server and the client machine (`EDGE_IP_TO_CLIENT_IP`).", "type": "string", "enum": [ "EDGE_IP_TO_ORIGIN_IP", "EDGE_IP_TO_CLIENT_IP" ] }, "executionStatus": { "description": "Status of the MTR request's execution. Possible values are `SUCCESS`, `FAILURE`, or `NOT_EXECUTED`. The `info` member and `FAILURE` in `errorResponse` provide details for `NOT_EXECUTED`.", "type": "string", "enum": [ "SUCCESS", "FAILURE", "NOT_EXECUTED" ] }, "info": { "additionalProperties": false, "description": "Specifies the reason for `NOT_EXECUTED` status.", "type": "object", "required": [ "key", "message" ], "properties": { "key": { "description": "Error key.", "minLength": 1, "type": "string" }, "message": { "description": "Details about the error.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/info.yaml" } }, "result": { "additionalProperties": false, "description": "Standard MTR results.", "type": "object", "required": [ "startTime", "host", "packetLoss", "averageLatency", "hops", "result" ], "properties": { "averageLatency": { "description": "Average latency for all hops, in seconds.", "minimum": 0, "type": "number" }, "hops": { "description": "Lists network hops with their data.", "minItems": 0, "type": "array", "items": { "additionalProperties": false, "description": "Collects network hops with their data.", "type": "object", "required": [ "number", "host", "ip", "ipLocation", "packetLoss", "sentPackets", "lastPacketLatency", "averageLatency", "bestRtt", "worstRtt", "standardDeviation" ], "properties": { "averageLatency": { "description": "Average hop value, useful to detect ongoing problems.", "minimum": 0, "type": "number" }, "bestRtt": { "description": "Fastest time, in milliseconds.", "minimum": 0, "type": "number" }, "host": { "description": "Host or domain name for the hop.", "minLength": 1, "type": "string" }, "ip": { "description": "IP of the hop's `edgeHost`.", "minLength": 1, "type": "string" }, "ipLocation": { "additionalProperties": false, "description": "Geolocation data for the hop's `edgeHost`.", "type": "object", "required": [ "city", "regionCode", "countryCode", "asNumber" ], "properties": { "asNumber": { "description": "Autonomous System Number the edge IP maps to.", "minimum": 0, "type": "integer" }, "city": { "description": "Closest city within a 50-mile radius the edge IP maps to.", "minLength": 1, "type": "string" }, "countryCode": { "description": "ISO 3166 country code the edge IP maps to.", "minLength": 1, "type": "string" }, "regionCode": { "description": "ISO 3166 region code the edge IP maps to.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/edgeIpLocation.yaml" } }, "lastPacketLatency": { "description": "Last measured hop value, useful to detect ongoing problems.", "minimum": 0, "type": "number" }, "number": { "description": "Index for each hop's count within the full set.", "minimum": 0, "type": "integer" }, "packetLoss": { "description": "Percentage of packets lost for the hop, maximum `100`.", "maximum": 100, "minimum": 0, "type": "number" }, "sentPackets": { "description": "Number of packets sent for the hop.", "minimum": 0, "type": "integer" }, "standardDeviation": { "description": "Standard deviation, in milliseconds.", "minimum": 0, "type": "number" }, "worstRtt": { "description": "Slowest time, in milliseconds.", "minimum": 0, "type": "number" } }, "x-akamai": { "file-path": "schemas/mtrHopInstance.yaml" } } }, "host": { "description": "Hostname within the edge network that corresponds to the `source` IP address.", "format": "hostname", "type": "string" }, "packetLoss": { "description": "Percentage of packets lost, maximum `100`.", "maximum": 100, "minimum": 0, "type": "number" }, "result": { "description": "Raw MTR utility output.", "minLength": 1, "type": "string" }, "startTime": { "description": "Epoch timestamp marking when MTR was run.", "type": "integer" } }, "x-akamai": { "file-path": "schemas/mtrData.yaml" } }, "sourceContext": { "description": "Context for MTR source. The source can be either an edge server forwarding the request to the origin server (`EDGE_IP_CONNECTED_TO_ORIGIN`) or an edge server in the location (`EDGE_IP_BASED_ON_LOCATION`), either selected randomly or provided in the request.", "type": "string", "enum": [ "EDGE_IP_CONNECTED_TO_ORIGIN", "EDGE_IP_BASED_ON_LOCATION" ] }, "sourceIpLocation": { "additionalProperties": false, "description": "Specifies the geolocation of the source IP.", "type": "object", "required": [ "city", "regionCode", "countryCode", "asNumber" ], "properties": { "asNumber": { "description": "Autonomous System Number the edge IP maps to.", "minimum": 0, "type": "integer" }, "city": { "description": "Closest city within a 50-mile radius the edge IP maps to.", "minLength": 1, "type": "string" }, "countryCode": { "description": "ISO 3166 country code the edge IP maps to.", "minLength": 1, "type": "string" }, "regionCode": { "description": "ISO 3166 region code the edge IP maps to.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/edgeIpLocation.yaml" } }, "suggestedActions": { "description": "Suggestions on what to do next with the results.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } } }, "x-akamai": { "file-path": "schemas/connectivity.yaml" } } }, "content": { "description": "Lists the results of the cURL request.", "minItems": 0, "type": "array", "items": { "additionalProperties": false, "type": "object", "required": [ "executionContext", "executionStatus" ], "properties": { "additionalRequestParameters": { "additionalProperties": false, "description": "Specifies the cURL request.", "minProperties": 1, "type": "object", "properties": { "includeDefaultPragmaHeaders": { "description": "Indicates whether the request included the default list of `Pragma` headers. Check [Pragma headers](https://techdocs.akamai.com/edge-diagnostics/docs/pragma-headers) to learn about default Akamai Pragma headers.", "type": "boolean" }, "ipVersion": { "description": "IP version used by the request, either `IPV4` or `IPV6`.", "type": "string", "enum": [ "IPV4", "IPV6" ] }, "requestHeaders": { "description": "Customized headers for `curl` request in the format `header: value`.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } } }, "x-akamai": { "file-path": "schemas/additionalCurlRequestParameters.yaml" } }, "errorResponse": { "additionalProperties": false, "description": "Specifies the reason for `FAILURE` status.", "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Details about the error.", "minLength": 1, "type": "string" }, "errors": { "description": "Collects information about problems occurred while fetching the data.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } }, "status": { "description": "Error status code.", "minLength": 1, "type": "string" }, "title": { "description": "Error title.", "minLength": 1, "type": "string" }, "type": { "description": "Error type.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/errorResponse.yaml" } }, "executionContext": { "description": "Execution context. The only possible value is `DEFAULT`. For now, this member doesn't provide any meaningful data.", "type": "string", "enum": [ "DEFAULT" ] }, "executionStatus": { "description": "Status of the cURL request's execution, either `SUCCESS` or `FAILURE`.", "type": "string", "enum": [ "SUCCESS", "FAILURE" ] }, "result": { "additionalProperties": false, "description": "Results of the `curl` command.", "minProperties": 1, "type": "object", "required": [ "exitCode" ], "properties": { "exitCode": { "description": "Curl command exit code. [List of possible curl exit code.](https://curl.se/libcurl/c/libcurl-errors.html) ", "minimum": 0, "type": "integer" }, "httpStatusCode": { "description": "Returned HTTP response code.", "maximum": 599, "minimum": 100, "type": "integer" }, "httpVersion": { "description": "HTTP version used for `curl`.", "minLength": 1, "type": "string" }, "reasonPhrase": { "description": "Reason phrase for the response.", "minLength": 1, "type": "string" }, "responseBody": { "description": "Entire response body.", "minLength": 1, "type": "string" }, "responseHeaderList": { "description": "Collects the response headers in the format `header: value`.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } }, "timing": { "additionalProperties": false, "description": "Collects the time related data.", "type": "object", "required": [ "dnsLookupTime", "tcpConnectionTime", "sslConnectionTime", "timeToFirstByte", "totalTime" ], "properties": { "dnsLookupTime": { "description": "DNS lookup time, in seconds.", "minimum": 0, "type": "number" }, "sslConnectionTime": { "description": "SSL connection time, in seconds.", "minimum": 0, "type": "number" }, "tcpConnectionTime": { "description": "TCP connection time, in seconds.", "minimum": 0, "type": "number" }, "timeToFirstByte": { "description": "Time to first byte, in seconds.", "minimum": 0, "type": "number" }, "totalTime": { "description": "Total time, in seconds.", "minimum": 0, "type": "number" } } } }, "x-akamai": { "file-path": "schemas/curlResults.yaml" } }, "suggestedActions": { "description": "Suggestions on what to do next with the results.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } } }, "x-akamai": { "file-path": "schemas/contentDetail.yaml" } } }, "cpCode": { "description": "CP code that applies to the URL of the request.", "minimum": 1, "type": "integer" }, "domainDetails": { "description": "Lists the results of the DIG request.", "minItems": 0, "type": "array", "items": { "additionalProperties": false, "type": "object", "required": [ "executionStatus" ], "properties": { "additionalRequestParameters": { "additionalProperties": false, "description": "Specifies the DIG request.", "minProperties": 1, "type": "object", "properties": { "queryType": { "description": "DNS query type fetched by the request. Possible values are: `A`, `AAAA`, `SOA`, `CNAME`, `PTR`, `MX`, `NS`, `TXT`, `SRV`, `CAA`, and `ANY`. To learn more about them, check [Supported DNS record types](https://techdocs.akamai.com/edge-diagnostics/docs/domain-details-dig#supported-dns-record-types).", "type": "string", "enum": [ "A", "SOA", "CNAME", "PTR", "MX", "AAAA", "NS", "TXT", "SRV", "CAA", "ANY" ] } }, "x-akamai": { "file-path": "schemas/additionalDigRequestParameters.yaml" } }, "errorResponse": { "additionalProperties": false, "description": "Specifies the reason for `FAILURE` status.", "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Details about the error.", "minLength": 1, "type": "string" }, "errors": { "description": "Collects information about problems occurred while fetching the data.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } }, "status": { "description": "Error status code.", "minLength": 1, "type": "string" }, "title": { "description": "Error title.", "minLength": 1, "type": "string" }, "type": { "description": "Error type.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/errorResponse.yaml" } }, "executionContext": { "description": "Execution context. The only possible value is `DEFAULT`. For now, this member doesn't provide any meaningful data.", "type": "string", "enum": [ "DEFAULT" ] }, "executionStatus": { "description": "Status of the DIG request's execution, either `SUCCESS` or `FAILURE`.", "type": "string", "enum": [ "SUCCESS", "FAILURE" ] }, "result": { "additionalProperties": false, "description": "Standard `dig` response.", "type": "object", "required": [ "result" ], "properties": { "answerSection": { "description": "Collects a DNS record of answering servers.", "minItems": 1, "type": "array", "items": { "additionalProperties": false, "description": "Specifies a DNS record that appears within a response of the [Get domain details with dig](https://techdocs.akamai.com/edge-diagnostics/reference/post-dig) operation, in `answerSection` or `authoritySection`.", "type": "object", "properties": { "domain": { "description": "Domain name for this record.", "minLength": 1, "type": "string" }, "hostname": { "description": "Hostname you requested the data for.", "format": "hostname", "type": "string" }, "preferenceValue": { "description": "Preference value, only valid for records of the `MX` type, otherwise `null`.", "minimum": 0, "nullable": true, "type": "integer" }, "recordClass": { "description": "Class of the record, typically `IN` for *internet*.", "minLength": 1, "type": "string" }, "recordType": { "description": "Requested record type. Possible values are: `A`, `AAAA`, `SOA`, `CNAME`, `PTR`, `MX`, `NS`, `TXT`, `SRV`, `CAA`, and `ANY`. To learn more about them, check [Supported DNS record types](https://techdocs.akamai.com/edge-diagnostics/docs/domain-details-dig#supported-dns-record-types).", "type": "string", "enum": [ "A", "AAAA", "SOA", "CNAME", "PTR", "MX", "NS", "TXT", "SRV", "CAA", "ANY" ] }, "ttl": { "description": "Server's default number of seconds to keep content cached.", "minimum": 0, "type": "integer" }, "value": { "description": "Record's value, either another domain or a final IP address.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/dnsRecord.yaml" }, "oneOf": [ { "title": "Hostname required", "required": [ "hostname", "ttl", "recordClass", "recordType", "value" ] }, { "title": "Domain required", "required": [ "domain", "ttl", "recordClass", "recordType", "value" ] } ] } }, "authoritySection": { "description": "Collects a DNS record of servers authorized to answer.", "minItems": 1, "type": "array", "items": { "additionalProperties": false, "description": "Specifies a DNS record that appears within a response of the [Get domain details with dig](https://techdocs.akamai.com/edge-diagnostics/reference/post-dig) operation, in `answerSection` or `authoritySection`.", "type": "object", "properties": { "domain": { "description": "Domain name for this record.", "minLength": 1, "type": "string" }, "hostname": { "description": "Hostname you requested the data for.", "format": "hostname", "type": "string" }, "preferenceValue": { "description": "Preference value, only valid for records of the `MX` type, otherwise `null`.", "minimum": 0, "nullable": true, "type": "integer" }, "recordClass": { "description": "Class of the record, typically `IN` for *internet*.", "minLength": 1, "type": "string" }, "recordType": { "description": "Requested record type. Possible values are: `A`, `AAAA`, `SOA`, `CNAME`, `PTR`, `MX`, `NS`, `TXT`, `SRV`, `CAA`, and `ANY`. To learn more about them, check [Supported DNS record types](https://techdocs.akamai.com/edge-diagnostics/docs/domain-details-dig#supported-dns-record-types).", "type": "string", "enum": [ "A", "AAAA", "SOA", "CNAME", "PTR", "MX", "NS", "TXT", "SRV", "CAA", "ANY" ] }, "ttl": { "description": "Server's default number of seconds to keep content cached.", "minimum": 0, "type": "integer" }, "value": { "description": "Record's value, either another domain or a final IP address.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/dnsRecord.yaml" }, "oneOf": [ { "title": "Hostname required", "required": [ "hostname", "ttl", "recordClass", "recordType", "value" ] }, { "title": "Domain required", "required": [ "domain", "ttl", "recordClass", "recordType", "value" ] } ] } }, "result": { "description": "Raw `dig` output.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/digInfo.yaml" } }, "suggestedActions": { "description": "Suggestions on what to do next with the results.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } } }, "x-akamai": { "file-path": "schemas/domainDetail.yaml" } } }, "edgeServerIp": { "description": "IP of the edge server used to serve the request.", "minLength": 1, "type": "string" }, "edgeStatusCode": { "description": "HTTP status code returned by the edge server.", "minLength": 1, "type": "string" }, "errorMessage": { "description": "Error message.", "minLength": 1, "type": "string" }, "logLines": { "description": "Lists the results of the GREP request.", "minItems": 0, "type": "array", "items": { "additionalProperties": false, "description": "Collects fetched logs.", "type": "object", "required": [ "executionContext", "executionStatus" ], "properties": { "errorResponse": { "additionalProperties": false, "description": "Specifies the reason for `FAILURE` status.", "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Details about the error.", "minLength": 1, "type": "string" }, "errors": { "description": "Collects information about problems occurred while fetching the data.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } }, "status": { "description": "Error status code.", "minLength": 1, "type": "string" }, "title": { "description": "Error title.", "minLength": 1, "type": "string" }, "type": { "description": "Error type.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/errorResponse.yaml" } }, "executionContext": { "description": "Execution context. The only possible value is `DEFAULT`. For now, this member doesn't provide any meaningful data.", "type": "string", "enum": [ "DEFAULT" ] }, "executionStatus": { "description": "Status of the GREP request's execution, either `SUCCESS` or `FAILURE`.", "type": "string", "enum": [ "SUCCESS", "FAILURE" ] }, "result": { "additionalProperties": false, "description": "Provides logs fetched with the GREP command.", "type": "object", "required": [ "logs", "legend" ], "properties": { "legend": { "additionalProperties": false, "description": "Descriptions of returned `logType`, `objectStatus`, `objectStatus2`, `objectStatus3` in `r` and `f` log lines.", "type": "object", "required": [ "logType", "rObjectStatus", "rObjectStatus2", "rObjectStatus3", "fObjectStatus", "fObjectStatus2", "fObjectStatus3" ], "properties": { "fObjectStatus": { "description": "Descriptions of the `objectStatus` data in f-line.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } }, "fObjectStatus2": { "description": "Descriptions of the `objectStatus2` data in f-line.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } }, "fObjectStatus3": { "description": "Descriptions of the `objectStatus3` data in f-line.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } }, "logType": { "description": "Description of the `logType` data.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } }, "rObjectStatus": { "description": "Descriptions of the `objectStatus` data in r-line.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } }, "rObjectStatus2": { "description": "Descriptions of the `objectStatus2` data in r-line.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } }, "rObjectStatus3": { "description": "Descriptions of the `objectStatus3` data in r-line.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } } }, "x-akamai": { "file-path": "schemas/legend.yaml" } }, "logs": { "description": "Filtered log lines.", "minItems": 0, "type": "array", "items": { "description": "Items provided as key/value pairs.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } } } }, "x-akamai": { "file-path": "schemas/logsContainer.yaml" } }, "suggestedActions": { "description": "Suggestions on what to do next with the results.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } } }, "x-akamai": { "file-path": "schemas/logLines.yaml" } } }, "originResponseCode": { "description": "HTTP status code returned by the origin server.", "minLength": 1, "type": "string" }, "originServerHostname": { "description": "Origin server hostname.", "format": "hostname", "type": "string" }, "originServerIp": { "description": "IP of the origin server used to serve the request.", "minLength": 1, "type": "string" }, "serialNumber": { "description": "Unique identifier for a server mapped to a region.", "minLength": 1, "type": "string" }, "ttl": { "description": "Remaining number of seconds to keep content cached, either a specific number or `Infinite`.", "minLength": 1, "type": "string" }, "typeCode": { "description": "Description of the server configuration.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/urlHealthCheckSummary.yaml" } } }, "x-akamai": { "file-path": "schemas/urlHealthCheckResponse.yaml" } } } }, "headers": { "X-RateLimit-Limit": { "description": "The rate limit ceiling for this endpoint.", "example": 10, "schema": { "type": "integer" }, "x-akamai": { "file-path": "headers/X-RateLimit-Limit.yaml" } }, "X-RateLimit-Remaining": { "description": "The number of requests left for the time window.", "example": 5, "schema": { "type": "integer" }, "x-akamai": { "file-path": "headers/X-RateLimit-Remaining.yaml" } } } }, "400": { "description": "[Validation error](https://techdocs.akamai.com/edge-diagnostics/reference/400).", "content": { "application/problem+json": { "example": { "detail": "Provide only one of these members, either `edgeLocationId` or `edgeIp`.", "status": 400, "title": "Incorrect request.", "type": "bad.request.error", "errors": [ { "requestField": "edgeLocationId", "title": "Conflicting values.", "type": "field.conflict" }, { "requestField": "edgeIp", "title": "Conflicting values.", "type": "field.conflict" } ] }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/400.yaml" } }, "401": { "description": "[Authorization error](https://techdocs.akamai.com/edge-diagnostics/reference/401).", "content": { "application/problem+json": { "example": { "detail": "Inactive client token", "instance": "https://akab-nedrvuylepskzabx-lv3dgceqqktx3i5b.luna.akamaiapis.net/edge-diagnostics/v1/grep/requests", "status": 401, "title": "Not authorized", "type": "https://problems.luna.akamaiapis.net/-/pep-authn/deny" }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/401.yaml" } }, "403": { "description": "[Permission error](https://techdocs.akamai.com/edge-diagnostics/reference/403).", "content": { "application/problem+json": { "example": { "status": 403, "title": "Forbidden request.", "type": "forbidden.request.error", "errors": [ { "detail": "You don't have access to the requested URL. Contact your Admin to request access.", "requestField": "url", "title": "Field access denied.", "type": "field.access.denied" } ] }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/403.yaml" } }, "405": { "description": "[Method not allowed](https://techdocs.akamai.com/edge-diagnostics/reference/405).", "content": { "application/problem+json": { "example": { "title": "Method not allowed", "type": "method.not.allowed" }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/405.yaml" } }, "429": { "description": "[Too many requests](https://techdocs.akamai.com/edge-diagnostics/reference/429).", "content": { "application/problem+json": { "example": { "detail": "You have exceeded total number of requests configured for this API.", "status": 429, "title": "Too Many Requests", "type": "requests.exceeded.error" }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/429.yaml" } } }, "parameters": [ { "description": "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ] } }, "/url-health-check/requests/{requestId}": { "get": { "description": "Returns the status of the [asynchronous](https://techdocs.akamai.com/edge-diagnostics/reference/asynchronous-processes) [Run the URL health check](https://techdocs.akamai.com/edge-diagnostics/reference/post-url-health-check) request. Operations with the `SUCCESS` status include also fetched GREP, dig, cURL, and MTR data.", "operationId": "get-url-health-check-requests", "summary": "Get a URL health check response", "tags": [ "URL Health Check" ], "externalDocs": { "description": "See documentation for this operation in Akamai's Edge Diagnostics API", "url": "https://techdocs.akamai.com/edge-diagnostics/reference/get-url-health-check-requests" }, "responses": { "200": { "description": "The response provides the status of the request and its details.", "content": { "application/json": { "example": { "createdBy": "adevi", "createdTime": "2021-09-29T05:07:30Z", "executionStatus": "SUCCESS", "internalIp": "192.0.2.5", "requestId": 365, "internalIpLocation": { "asNumber": 20940, "city": "ASHBURN", "countryCode": "US", "regionCode": "VA" }, "request": { "edgeLocationId": "allen-tx-unitedregionCodes", "ipVersion": "IPV6", "packetType": "TCP", "port": 80, "queryType": "A", "spoofEdgeIp": "192.0.2.9", "url": "http://www.atcuser15.akamaiu.com", "viewsAllowed": [ "CONNECTIVITY", "LOGS" ] }, "spoofEdgeIpLocation": { "asNumber": 20940, "city": "MUMBAI", "countryCode": "IN", "regionCode": "MH" }, "summary": { "cacheKeyHostname": "www.example.com", "cacheSetting": "TCP_MISS", "cpCode": 1234567, "edgeServerIp": "192.0.2.5", "edgeStatusCode": "200", "originResponseCode": "200", "originServerHostname": "www.example.com", "originServerIp": "2001:db8:e865:713c:d8fd:4d8a:ab68:2ee5", "serialNumber": "1580", "ttl": "Infinite", "typeCode": " Object changes when ARL changes", "connectivity": [ { "destinationContext": "ORIGIN_IP", "executionContext": "EDGE_IP_TO_ORIGIN_IP", "executionStatus": "SUCCESS", "sourceContext": "EDGE_IP_CONNECTED_TO_ORIGIN", "suggestedActions": [ "Look for a packet loss or sudden jumps in the hop time.", "For a loss or latency within the end user ISP network, ask the end user to contact thier ISP.", "For a loss or latency within Akamai network, contact Akamai Technical Support.", "If a packet loss occurs at one hop but does not propogate to the end of the trace, it is irrelevant." ], "additionalRequestParameters": { "destination": "2001:db8:e2fd:1066:3516:ba75:f20c:148", "source": "192.0.2.14" }, "destinationIpLocation": { "asNumber": 20940, "city": "ASHBURN", "countryCode": "US", "regionCode": "VA" }, "result": { "host": "a23-212-50-38.deploy.akamaitechnologies.com", "hops": [ { "averageLatency": 0, "bestRtt": 0, "host": "???", "lastPacketLatency": 0, "number": 12, "packetLoss": 100, "sentPackets": 10, "standardDeviation": 0, "worstRtt": 0 }, { "averageLatency": 0, "bestRtt": 0, "host": "???", "lastPacketLatency": 0, "number": 1, "packetLoss": 100, "sentPackets": 10, "standardDeviation": 0, "worstRtt": 0 } ] }, "sourceIpLocation": { "asNumber": 20940, "city": "MUMBAI", "countryCode": "IN", "regionCode": "MH" } } ], "content": [ { "executionContext": "DEFAULT", "executionStatus": "SUCCESS", "suggestedActions": [ "Compare the response headers served from edge and origin.", "Check for content correctness.", "Check content length/bytes served." ], "additionalRequestParameters": { "requestHeaders": [ "Pragma: akamai-x-cache-on, akamai-x-cache-remote-on, akamai-x-check-cacheable, akamai-x-get-true-cache-key, akamai-x-get-cache-key, akamai-x-serial-no, akamai-x-get-request-id" ] }, "result": { "responseHeaderList": [ "Last-Modified: Thu, 12 Feb 2015 15:44:28 GMT", "Content-Length: 15051" ] } } ], "domainDetails": [ { "executionContext": "DEFAULT", "executionStatus": "SUCCESS", "result": { "answerSection": [ { "hostname": "www.atcuser15.akamaiu.com.", "recordClass": "IN", "recordType": "CNAME", "ttl": 82108, "value": "www.example.com.edgesuite.net." }, { "hostname": "a1580.dscr.akamai.net.", "recordClass": "IN", "recordType": "A", "ttl": 20, "value": "192.0.2.238" } ] } } ], "logLines": [ { "executionContext": "DEFAULT", "executionStatus": "SUCCESS", "suggestedActions": [ "Check for long times.", "Check content length/bytes served." ], "result": { "legend": { "fObjectStatus": { "D": "A default object was served.", "a": "This response was sent through the ESI processor.", "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." }, "fObjectStatus2": {}, "fObjectStatus3": {}, "logType": { "f": "(f) going forward to forward hostname" }, "rObjectStatus": {}, "rObjectStatus2": {}, "rObjectStatus3": {} }, "logs": [ { "clientIp": "192.0.2.5", "contentBytesServed": "-", "edgeIp": "192.0.2.14", "forwardIp": "192.0.2.15", "logType": "f", "objectStatus": "oaDx", "timeTaken": "0", "turnaroundTime": "266" } ] } } ] }, "connectivity": [ { "destinationContext": "ORIGIN_IP", "executionContext": "EDGE_IP_TO_ORIGIN_IP", "executionStatus": "SUCCESS", "sourceContext": "EDGE_IP_CONNECTED_TO_ORIGIN", "suggestedActions": [ "Look for a packet loss or sudden jumps in the hop time.", "For a loss or latency within the end user ISP network, ask the end user to contact thier ISP.", "For a loss or latency within Akamai network, contact Akamai Technical Support.", "If a packet loss occurs at one hop but does not propogate to the end of the trace, it is irrelevant.", "If source Ip country and destination IP country is same then there should not be any hops outside the country." ], "additionalRequestParameters": { "destination": "2001:db8:1376:df60:2c54:eeef:56c2:2a5a", "source": "192.0.2.14" }, "destinationIpLocation": { "asNumber": 20940, "city": "ASHBURN", "countryCode": "US", "regionCode": "VA" }, "result": { "averageLatency": 204.1, "host": "a23-212-50-38.deploy.akamaitechnologies.com", "packetLoss": 0, "result": "Start: 2021-09-29T05:08:20+0000\nHOST: a23-212-50-38.deploy.akamaitechnologies.com Loss% Snt Last Avg Best Wrst StDev\n 1.|-- ??? 100.0 10 0.0 0.0 0.0 0.0 0.0\n 2.|-- 2403:0:100::911 0.0% 10 0.4 0.4 0.3 0.5 0.1\n 3.|-- if-ae-1-101.tcore2.mlv-mumbai.ipv6.as6453.net (2001:db8::c) 0.0% 10 8.4 2.5 0.4 10.3 3.7\n 4.|-- if-ae-12-2.tcore1.l78-london.ipv6.as6453.net (2001:db8::d) 0.0% 10 128.3 138.9 125.2 216.0 28.0\n 5.|-- if-ae-15-2.tcore3.njy-newark.ipv6.as6453.net (2001:db8::e) 0.0% 10 196.7 198.9 195.0 210.5 4.5\n 6.|-- if-ae-1-3.tcore4.njy-newark.ipv6.as6453.net (2001:db8::b) 0.0% 10 199.4 199.6 196.6 201.4 1.4\n 7.|-- if-ae-12-2.tcore3.aeq-ashburn.ipv6.as6453.net (2001:db8::b) 0.0% 10 206.5 206.4 204.3 216.0 3.5\n 8.|-- 2001:5a0:600:502::2 0.0% 10 204.4 204.5 201.9 206.6 1.6\n 9.|-- ae1.r01.iad01.icn.netarch.akamai.com (2600:1488:a180:125::a) 0.0% 10 205.1 205.7 200.4 209.4 2.3\n 10.|-- ae3.r01.iad03.icn.netarch.akamai.com (2600:1488:5fc3:4d::b) 0.0% 10 206.6 205.1 200.2 214.0 4.3\n 11.|-- ae5.r01.iad03.ien.netarch.akamai.com (2600:1488:a181:111::b) 0.0% 10 205.2 205.2 196.3 219.4 6.0\n 12.|-- ??? 100.0 10 0.0 0.0 0.0 0.0 0.0\n 13.|-- g2600-1408-7400-0000-0000-0000-17c7-3f1b.deploy.static.akamaitechnologies.com (2 0.0% 10 200.7 204.1 200.3 205.9 2.0", "startTime": 1632892100, "hops": [ { "averageLatency": 0, "bestRtt": 0, "host": "???", "lastPacketLatency": 0, "number": 1, "packetLoss": 100, "sentPackets": 10, "standardDeviation": 0, "worstRtt": 0 }, { "averageLatency": 204.1, "bestRtt": 200.3, "host": "g2600-1408-7400-0000-0000-0000-17c7-3f1b.deploy.static.akamaitechnologies.com", "lastPacketLatency": 200.7, "number": 2, "packetLoss": 0, "sentPackets": 10, "standardDeviation": 2, "worstRtt": 205.9 } ] }, "sourceIpLocation": { "asNumber": 20940, "city": "MUMBAI", "countryCode": "IN", "regionCode": "MH" } } ], "content": [ { "executionContext": "DEFAULT", "executionStatus": "SUCCESS", "suggestedActions": [ "Compare the response headers served from edge and origin.", "Check for content correctness.", "Check content length/bytes served." ], "additionalRequestParameters": { "requestHeaders": [ "Pragma: akamai-x-cache-on, akamai-x-cache-remote-on, akamai-x-check-cacheable, akamai-x-get-true-cache-key, akamai-x-get-cache-key, akamai-x-serial-no, akamai-x-get-request-id" ] }, "result": { "httpStatusCode": 200, "httpVersion": "HTTP/1.1", "reasonPhrase": "OK", "responseHeaderList": [ "X-Cache: TCP_MISS from a23-212-50-38.deploy.akamaitechnologies.com (AkamaiGHost/10.4.4-34537092) (-)", "X-True-Cache-Key: /D/000/akamaiflowershop.com/ vcd=1456", "Server: Apache/2.4.7 (Ubuntu)", "Content-Length: 15051", "Content-Type: text/html" ], "timing": { "dnsLookupTime": 1.509502, "sslConnectionTime": 0, "tcpConnectionTime": 1.524193, "timeToFirstByte": 1.555875, "totalTime": 2.091051 } } } ], "domainDetails": [ { "executionContext": "DEFAULT", "executionStatus": "SUCCESS", "result": { "result": "\n; <<>> DiG 9.11.3-1ubuntu1.14aka10.0.8-Ubuntu <<>> www.atcuser15.akamaiu.com -t A\n;; global options: +cmd\n;; Got answer:\n;; ->>HEADER<<- opcode: QUERY, status: NOERROR, id: 27583\n;; flags: qr rd ra; QUERY: 1, ANSWER: 4, AUTHORITY: 0, ADDITIONAL: 1\n\n;; OPT PSEUDOSECTION:\n; EDNS: version: 0, flags:; udp: 4096\n; COOKIE: 5ed2048bbeaf4087d1154fba6153f49926837baa0b15243d (good)\n;; QUESTION SECTION:\n;www.atcuser15.akamaiu.com.\tIN\tA\n\n;; ANSWER SECTION:\nwww.atcuser15.akamaiu.com. 82108 IN\tCNAME\twww.example.com.edgesuite.net.\nwww.example.com.edgesuite.net. 17308 IN CNAME\ta1580.dscr.akamai.net.\na1580.dscr.akamai.net.\t20\tIN\tA\t23.50.51.203\na1580.dscr.akamai.net.\t20\tIN\tA\t23.50.51.240\n\n;; Query time: 1 msec\n;; SERVER: 127.0.0.1#53(127.0.0.1)\n;; WHEN: Wed Sep 29 05:07:37 UTC 2021\n;; MSG SIZE rcvd: 202\n", "answerSection": [ { "hostname": "www.atcuser15.akamaiu.com.", "recordClass": "IN", "recordType": "CNAME", "ttl": 82108, "value": "www.example.com.edgesuite.net." }, { "hostname": "a1580.dscr.akamai.net.", "recordClass": "IN", "recordType": "A", "ttl": 20, "value": "192.0.2.12" } ] } } ], "logLines": [ { "executionContext": "DEFAULT", "executionStatus": "SUCCESS", "suggestedActions": [ "Check for long times.", "Check content length/bytes served." ], "result": { "legend": { "fObjectStatus": { "D": "A default object was served.", "a": "This response was sent through the ESI processor.", "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." }, "fObjectStatus2": {}, "fObjectStatus3": {}, "logType": { "f": "(f) going forward to forward hostname" }, "rObjectStatus": {}, "rObjectStatus2": {}, "rObjectStatus3": {} }, "logs": [ { "arl": "/D/1580/1234567/000/akamaiflowershop.com/", "bytesReceived": "3980", "bytesServed": "-", "clientIp": "192.0.2.5", "contentBytesServed": "-", "contentType": "text/html", "cookie": "-", "cpCode": "1234567", "dateTime": "2021-09-29T05:07:44.733Z", "edgeIp": "192.0.2.14", "error": "-", "forwardIp": "192.0.2.15", "hostHeader": "-", "httpMethod": "GET", "httpStatus": "200", "logType": "f", "objectSize": "-", "objectStatus": "oaDx", "objectStatus2": "-", "objectStatus3": "-", "referer": "-", "sslVersion": "-", "timeTaken": "0", "turnaroundTime": "266", "userAgent": "-" } ] } } ] }, "schema": { "additionalProperties": false, "description": "Collects the URL health check results and details about the request.", "type": "object", "required": [ "summary", "content", "connectivity", "createdBy", "createdTime", "domainDetails", "executionStatus", "internalIp", "internalIpLocation", "logLines", "request", "requestId" ], "properties": { "connectivity": { "description": "Lists the results of the MTR request. Shows only if the request included `CONNECTIVITY` in the `viewsAllowed` array.", "minItems": 0, "type": "array", "items": { "additionalProperties": false, "type": "object", "required": [ "executionStatus", "sourceIpLocation", "destinationIpLocation", "sourceContext", "destinationContext", "executionContext" ], "properties": { "additionalRequestParameters": { "additionalProperties": false, "description": "Specifies the MTR request.", "minProperties": 1, "type": "object", "required": [ "source", "destination" ], "properties": { "destination": { "description": "Destination of the request.", "minLength": 1, "type": "string" }, "ipVersion": { "description": "IP version used by the request, either `IPV4` or `IPV6`.", "type": "string", "enum": [ "IPV4", "IPV6" ] }, "packetType": { "description": "Packet type used by the request, either `ICMP` or `TCP`.", "type": "string", "enum": [ "ICMP", "TCP" ] }, "port": { "description": "Port number used by the request, either `80` or `443`.", "type": "integer", "enum": [ 80, 443 ] }, "source": { "description": "Source of the request.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/additionalMtrRequestParameters.yaml" } }, "destinationContext": { "description": "Whether the destination IP is a `CLIENT_IP` or `ORIGIN_IP`.", "type": "string", "enum": [ "ORIGIN_IP", "CLIENT_IP" ] }, "destinationIpLocation": { "additionalProperties": false, "description": "Specifies the geolocation of the origin server IP.", "type": "object", "required": [ "city", "regionCode", "countryCode", "asNumber" ], "properties": { "asNumber": { "description": "Autonomous System Number the edge IP maps to.", "minimum": 0, "type": "integer" }, "city": { "description": "Closest city within a 50-mile radius the edge IP maps to.", "minLength": 1, "type": "string" }, "countryCode": { "description": "ISO 3166 country code the edge IP maps to.", "minLength": 1, "type": "string" }, "regionCode": { "description": "ISO 3166 region code the edge IP maps to.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/edgeIpLocation.yaml" } }, "errorResponse": { "additionalProperties": false, "description": "Specifies the reason for `FAILURE` status.", "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Details about the error.", "minLength": 1, "type": "string" }, "errors": { "description": "Collects information about problems occurred while fetching the data.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } }, "status": { "description": "Error status code.", "minLength": 1, "type": "string" }, "title": { "description": "Error title.", "minLength": 1, "type": "string" }, "type": { "description": "Error type.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/errorResponse.yaml" } }, "executionContext": { "description": "Execution context for MTR. Edge Diagnostics executes MTR between an edge server and the origin server (`EDGE_IP_TO_ORIGIN_IP`) or, if a client IP is present in the request, between an edge server and the client machine (`EDGE_IP_TO_CLIENT_IP`).", "type": "string", "enum": [ "EDGE_IP_TO_ORIGIN_IP", "EDGE_IP_TO_CLIENT_IP" ] }, "executionStatus": { "description": "Status of the MTR request's execution. Possible values are `SUCCESS`, `FAILURE`, or `NOT_EXECUTED`. The `info` member and `FAILURE` in `errorResponse` provide details for `NOT_EXECUTED`.", "type": "string", "enum": [ "SUCCESS", "FAILURE", "NOT_EXECUTED" ] }, "info": { "additionalProperties": false, "description": "Specifies the reason for `NOT_EXECUTED` status.", "type": "object", "required": [ "key", "message" ], "properties": { "key": { "description": "Error key.", "minLength": 1, "type": "string" }, "message": { "description": "Details about the error.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/info.yaml" } }, "result": { "additionalProperties": false, "description": "Standard MTR results.", "type": "object", "required": [ "startTime", "host", "packetLoss", "averageLatency", "hops", "result" ], "properties": { "averageLatency": { "description": "Average latency for all hops, in seconds.", "minimum": 0, "type": "number" }, "hops": { "description": "Lists network hops with their data.", "minItems": 0, "type": "array", "items": { "additionalProperties": false, "description": "Collects network hops with their data.", "type": "object", "required": [ "number", "host", "ip", "ipLocation", "packetLoss", "sentPackets", "lastPacketLatency", "averageLatency", "bestRtt", "worstRtt", "standardDeviation" ], "properties": { "averageLatency": { "description": "Average hop value, useful to detect ongoing problems.", "minimum": 0, "type": "number" }, "bestRtt": { "description": "Fastest time, in milliseconds.", "minimum": 0, "type": "number" }, "host": { "description": "Host or domain name for the hop.", "minLength": 1, "type": "string" }, "ip": { "description": "IP of the hop's `edgeHost`.", "minLength": 1, "type": "string" }, "ipLocation": { "additionalProperties": false, "description": "Geolocation data for the hop's `edgeHost`.", "type": "object", "required": [ "city", "regionCode", "countryCode", "asNumber" ], "properties": { "asNumber": { "description": "Autonomous System Number the edge IP maps to.", "minimum": 0, "type": "integer" }, "city": { "description": "Closest city within a 50-mile radius the edge IP maps to.", "minLength": 1, "type": "string" }, "countryCode": { "description": "ISO 3166 country code the edge IP maps to.", "minLength": 1, "type": "string" }, "regionCode": { "description": "ISO 3166 region code the edge IP maps to.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/edgeIpLocation.yaml" } }, "lastPacketLatency": { "description": "Last measured hop value, useful to detect ongoing problems.", "minimum": 0, "type": "number" }, "number": { "description": "Index for each hop's count within the full set.", "minimum": 0, "type": "integer" }, "packetLoss": { "description": "Percentage of packets lost for the hop, maximum `100`.", "maximum": 100, "minimum": 0, "type": "number" }, "sentPackets": { "description": "Number of packets sent for the hop.", "minimum": 0, "type": "integer" }, "standardDeviation": { "description": "Standard deviation, in milliseconds.", "minimum": 0, "type": "number" }, "worstRtt": { "description": "Slowest time, in milliseconds.", "minimum": 0, "type": "number" } }, "x-akamai": { "file-path": "schemas/mtrHopInstance.yaml" } } }, "host": { "description": "Hostname within the edge network that corresponds to the `source` IP address.", "format": "hostname", "type": "string" }, "packetLoss": { "description": "Percentage of packets lost, maximum `100`.", "maximum": 100, "minimum": 0, "type": "number" }, "result": { "description": "Raw MTR utility output.", "minLength": 1, "type": "string" }, "startTime": { "description": "Epoch timestamp marking when MTR was run.", "type": "integer" } }, "x-akamai": { "file-path": "schemas/mtrData.yaml" } }, "sourceContext": { "description": "Context for MTR source. The source can be either an edge server forwarding the request to the origin server (`EDGE_IP_CONNECTED_TO_ORIGIN`) or an edge server in the location (`EDGE_IP_BASED_ON_LOCATION`), either selected randomly or provided in the request.", "type": "string", "enum": [ "EDGE_IP_CONNECTED_TO_ORIGIN", "EDGE_IP_BASED_ON_LOCATION" ] }, "sourceIpLocation": { "additionalProperties": false, "description": "Specifies the geolocation of the source IP.", "type": "object", "required": [ "city", "regionCode", "countryCode", "asNumber" ], "properties": { "asNumber": { "description": "Autonomous System Number the edge IP maps to.", "minimum": 0, "type": "integer" }, "city": { "description": "Closest city within a 50-mile radius the edge IP maps to.", "minLength": 1, "type": "string" }, "countryCode": { "description": "ISO 3166 country code the edge IP maps to.", "minLength": 1, "type": "string" }, "regionCode": { "description": "ISO 3166 region code the edge IP maps to.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/edgeIpLocation.yaml" } }, "suggestedActions": { "description": "Suggestions on what to do next with the results.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } } }, "x-akamai": { "file-path": "schemas/connectivity.yaml" } } }, "content": { "description": "Lists the results of the cURL request.", "minItems": 0, "type": "array", "items": { "additionalProperties": false, "type": "object", "required": [ "executionContext", "executionStatus" ], "properties": { "additionalRequestParameters": { "additionalProperties": false, "description": "Specifies the cURL request.", "minProperties": 1, "type": "object", "properties": { "includeDefaultPragmaHeaders": { "description": "Indicates whether the request included the default list of `Pragma` headers. Check [Pragma headers](https://techdocs.akamai.com/edge-diagnostics/docs/pragma-headers) to learn about default Akamai Pragma headers.", "type": "boolean" }, "ipVersion": { "description": "IP version used by the request, either `IPV4` or `IPV6`.", "type": "string", "enum": [ "IPV4", "IPV6" ] }, "requestHeaders": { "description": "Customized headers for `curl` request in the format `header: value`.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } } }, "x-akamai": { "file-path": "schemas/additionalCurlRequestParameters.yaml" } }, "errorResponse": { "additionalProperties": false, "description": "Specifies the reason for `FAILURE` status.", "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Details about the error.", "minLength": 1, "type": "string" }, "errors": { "description": "Collects information about problems occurred while fetching the data.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } }, "status": { "description": "Error status code.", "minLength": 1, "type": "string" }, "title": { "description": "Error title.", "minLength": 1, "type": "string" }, "type": { "description": "Error type.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/errorResponse.yaml" } }, "executionContext": { "description": "Execution context. The only possible value is `DEFAULT`. For now, this member doesn't provide any meaningful data.", "type": "string", "enum": [ "DEFAULT" ] }, "executionStatus": { "description": "Status of the cURL request's execution, either `SUCCESS` or `FAILURE`.", "type": "string", "enum": [ "SUCCESS", "FAILURE" ] }, "result": { "additionalProperties": false, "description": "Results of the `curl` command.", "minProperties": 1, "type": "object", "required": [ "exitCode" ], "properties": { "exitCode": { "description": "Curl command exit code. [List of possible curl exit code.](https://curl.se/libcurl/c/libcurl-errors.html) ", "minimum": 0, "type": "integer" }, "httpStatusCode": { "description": "Returned HTTP response code.", "maximum": 599, "minimum": 100, "type": "integer" }, "httpVersion": { "description": "HTTP version used for `curl`.", "minLength": 1, "type": "string" }, "reasonPhrase": { "description": "Reason phrase for the response.", "minLength": 1, "type": "string" }, "responseBody": { "description": "Entire response body.", "minLength": 1, "type": "string" }, "responseHeaderList": { "description": "Collects the response headers in the format `header: value`.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } }, "timing": { "additionalProperties": false, "description": "Collects the time related data.", "type": "object", "required": [ "dnsLookupTime", "tcpConnectionTime", "sslConnectionTime", "timeToFirstByte", "totalTime" ], "properties": { "dnsLookupTime": { "description": "DNS lookup time, in seconds.", "minimum": 0, "type": "number" }, "sslConnectionTime": { "description": "SSL connection time, in seconds.", "minimum": 0, "type": "number" }, "tcpConnectionTime": { "description": "TCP connection time, in seconds.", "minimum": 0, "type": "number" }, "timeToFirstByte": { "description": "Time to first byte, in seconds.", "minimum": 0, "type": "number" }, "totalTime": { "description": "Total time, in seconds.", "minimum": 0, "type": "number" } } } }, "x-akamai": { "file-path": "schemas/curlResults.yaml" } }, "suggestedActions": { "description": "Suggestions on what to do next with the results.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } } }, "x-akamai": { "file-path": "schemas/contentDetail.yaml" } } }, "createdBy": { "description": "Username who submitted the request.", "minLength": 1, "type": "string" }, "createdTime": { "description": "ISO 8601 timestamp indicating when the request was submitted.", "format": "date-time", "type": "string" }, "domainDetails": { "description": "Lists the results of the DIG request.", "minItems": 0, "type": "array", "items": { "additionalProperties": false, "type": "object", "required": [ "executionStatus" ], "properties": { "additionalRequestParameters": { "additionalProperties": false, "description": "Specifies the DIG request.", "minProperties": 1, "type": "object", "properties": { "queryType": { "description": "DNS query type fetched by the request. Possible values are: `A`, `AAAA`, `SOA`, `CNAME`, `PTR`, `MX`, `NS`, `TXT`, `SRV`, `CAA`, and `ANY`. To learn more about them, check [Supported DNS record types](https://techdocs.akamai.com/edge-diagnostics/docs/domain-details-dig#supported-dns-record-types).", "type": "string", "enum": [ "A", "SOA", "CNAME", "PTR", "MX", "AAAA", "NS", "TXT", "SRV", "CAA", "ANY" ] } }, "x-akamai": { "file-path": "schemas/additionalDigRequestParameters.yaml" } }, "errorResponse": { "additionalProperties": false, "description": "Specifies the reason for `FAILURE` status.", "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Details about the error.", "minLength": 1, "type": "string" }, "errors": { "description": "Collects information about problems occurred while fetching the data.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } }, "status": { "description": "Error status code.", "minLength": 1, "type": "string" }, "title": { "description": "Error title.", "minLength": 1, "type": "string" }, "type": { "description": "Error type.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/errorResponse.yaml" } }, "executionContext": { "description": "Execution context. The only possible value is `DEFAULT`. For now, this member doesn't provide any meaningful data.", "type": "string", "enum": [ "DEFAULT" ] }, "executionStatus": { "description": "Status of the DIG request's execution, either `SUCCESS` or `FAILURE`.", "type": "string", "enum": [ "SUCCESS", "FAILURE" ] }, "result": { "additionalProperties": false, "description": "Standard `dig` response.", "type": "object", "required": [ "result" ], "properties": { "answerSection": { "description": "Collects a DNS record of answering servers.", "minItems": 1, "type": "array", "items": { "additionalProperties": false, "description": "Specifies a DNS record that appears within a response of the [Get domain details with dig](https://techdocs.akamai.com/edge-diagnostics/reference/post-dig) operation, in `answerSection` or `authoritySection`.", "type": "object", "properties": { "domain": { "description": "Domain name for this record.", "minLength": 1, "type": "string" }, "hostname": { "description": "Hostname you requested the data for.", "format": "hostname", "type": "string" }, "preferenceValue": { "description": "Preference value, only valid for records of the `MX` type, otherwise `null`.", "minimum": 0, "nullable": true, "type": "integer" }, "recordClass": { "description": "Class of the record, typically `IN` for *internet*.", "minLength": 1, "type": "string" }, "recordType": { "description": "Requested record type. Possible values are: `A`, `AAAA`, `SOA`, `CNAME`, `PTR`, `MX`, `NS`, `TXT`, `SRV`, `CAA`, and `ANY`. To learn more about them, check [Supported DNS record types](https://techdocs.akamai.com/edge-diagnostics/docs/domain-details-dig#supported-dns-record-types).", "type": "string", "enum": [ "A", "AAAA", "SOA", "CNAME", "PTR", "MX", "NS", "TXT", "SRV", "CAA", "ANY" ] }, "ttl": { "description": "Server's default number of seconds to keep content cached.", "minimum": 0, "type": "integer" }, "value": { "description": "Record's value, either another domain or a final IP address.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/dnsRecord.yaml" }, "oneOf": [ { "title": "Hostname required", "required": [ "hostname", "ttl", "recordClass", "recordType", "value" ] }, { "title": "Domain required", "required": [ "domain", "ttl", "recordClass", "recordType", "value" ] } ] } }, "authoritySection": { "description": "Collects a DNS record of servers authorized to answer.", "minItems": 1, "type": "array", "items": { "additionalProperties": false, "description": "Specifies a DNS record that appears within a response of the [Get domain details with dig](https://techdocs.akamai.com/edge-diagnostics/reference/post-dig) operation, in `answerSection` or `authoritySection`.", "type": "object", "properties": { "domain": { "description": "Domain name for this record.", "minLength": 1, "type": "string" }, "hostname": { "description": "Hostname you requested the data for.", "format": "hostname", "type": "string" }, "preferenceValue": { "description": "Preference value, only valid for records of the `MX` type, otherwise `null`.", "minimum": 0, "nullable": true, "type": "integer" }, "recordClass": { "description": "Class of the record, typically `IN` for *internet*.", "minLength": 1, "type": "string" }, "recordType": { "description": "Requested record type. Possible values are: `A`, `AAAA`, `SOA`, `CNAME`, `PTR`, `MX`, `NS`, `TXT`, `SRV`, `CAA`, and `ANY`. To learn more about them, check [Supported DNS record types](https://techdocs.akamai.com/edge-diagnostics/docs/domain-details-dig#supported-dns-record-types).", "type": "string", "enum": [ "A", "AAAA", "SOA", "CNAME", "PTR", "MX", "NS", "TXT", "SRV", "CAA", "ANY" ] }, "ttl": { "description": "Server's default number of seconds to keep content cached.", "minimum": 0, "type": "integer" }, "value": { "description": "Record's value, either another domain or a final IP address.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/dnsRecord.yaml" }, "oneOf": [ { "title": "Hostname required", "required": [ "hostname", "ttl", "recordClass", "recordType", "value" ] }, { "title": "Domain required", "required": [ "domain", "ttl", "recordClass", "recordType", "value" ] } ] } }, "result": { "description": "Raw `dig` output.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/digInfo.yaml" } }, "suggestedActions": { "description": "Suggestions on what to do next with the results.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } } }, "x-akamai": { "file-path": "schemas/domainDetail.yaml" } } }, "errorResponse": { "additionalProperties": false, "description": "Specifies the reason for `FAILURE` status.", "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Details about the error.", "minLength": 1, "type": "string" }, "errors": { "description": "Collects information about problems occurred while fetching the data.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } }, "status": { "description": "Error status code.", "minLength": 1, "type": "string" }, "title": { "description": "Error title.", "minLength": 1, "type": "string" }, "type": { "description": "Error type.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/errorResponse.yaml" } }, "executionStatus": { "description": "Status of the request's execution. Possible values are: `SUCCESS`, `FAILURE`, or `IN_PROGRESS`.", "type": "string", "enum": [ "SUCCESS", "FAILURE", "IN_PROGRESS" ] }, "internalIp": { "description": "Machine IP for the requested location used to forward the request to the origin server.", "minLength": 1, "type": "string" }, "internalIpLocation": { "additionalProperties": false, "description": "Specifies the geolocation of `internalIp`.", "type": "object", "required": [ "city", "regionCode", "countryCode", "asNumber" ], "properties": { "asNumber": { "description": "Autonomous System Number the edge IP maps to.", "minimum": 0, "type": "integer" }, "city": { "description": "Closest city within a 50-mile radius the edge IP maps to.", "minLength": 1, "type": "string" }, "countryCode": { "description": "ISO 3166 country code the edge IP maps to.", "minLength": 1, "type": "string" }, "regionCode": { "description": "ISO 3166 region code the edge IP maps to.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/edgeIpLocation.yaml" } }, "link": { "description": "Link to get the URL health check response after the `retryAfter` interval passes. It occurs only for operations with the `IN_PROGRESS` status.", "minLength": 1, "type": "string" }, "logLines": { "description": "Lists the results of the GREP request. Shows only if the request included `LOGS` in the `viewsAllowed` array.", "minItems": 0, "type": "array", "items": { "additionalProperties": false, "description": "Collects fetched logs.", "type": "object", "required": [ "executionContext", "executionStatus" ], "properties": { "errorResponse": { "additionalProperties": false, "description": "Specifies the reason for `FAILURE` status.", "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Details about the error.", "minLength": 1, "type": "string" }, "errors": { "description": "Collects information about problems occurred while fetching the data.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } }, "status": { "description": "Error status code.", "minLength": 1, "type": "string" }, "title": { "description": "Error title.", "minLength": 1, "type": "string" }, "type": { "description": "Error type.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/errorResponse.yaml" } }, "executionContext": { "description": "Execution context. The only possible value is `DEFAULT`. For now, this member doesn't provide any meaningful data.", "type": "string", "enum": [ "DEFAULT" ] }, "executionStatus": { "description": "Status of the GREP request's execution, either `SUCCESS` or `FAILURE`.", "type": "string", "enum": [ "SUCCESS", "FAILURE" ] }, "result": { "additionalProperties": false, "description": "Provides logs fetched with the GREP command.", "type": "object", "required": [ "logs", "legend" ], "properties": { "legend": { "additionalProperties": false, "description": "Descriptions of returned `logType`, `objectStatus`, `objectStatus2`, `objectStatus3` in `r` and `f` log lines.", "type": "object", "required": [ "logType", "rObjectStatus", "rObjectStatus2", "rObjectStatus3", "fObjectStatus", "fObjectStatus2", "fObjectStatus3" ], "properties": { "fObjectStatus": { "description": "Descriptions of the `objectStatus` data in f-line.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } }, "fObjectStatus2": { "description": "Descriptions of the `objectStatus2` data in f-line.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } }, "fObjectStatus3": { "description": "Descriptions of the `objectStatus3` data in f-line.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } }, "logType": { "description": "Description of the `logType` data.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } }, "rObjectStatus": { "description": "Descriptions of the `objectStatus` data in r-line.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } }, "rObjectStatus2": { "description": "Descriptions of the `objectStatus2` data in r-line.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } }, "rObjectStatus3": { "description": "Descriptions of the `objectStatus3` data in r-line.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } } }, "x-akamai": { "file-path": "schemas/legend.yaml" } }, "logs": { "description": "Filtered log lines.", "minItems": 0, "type": "array", "items": { "description": "Items provided as key/value pairs.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } } } }, "x-akamai": { "file-path": "schemas/logsContainer.yaml" } }, "suggestedActions": { "description": "Suggestions on what to do next with the results.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } } }, "x-akamai": { "file-path": "schemas/logLines.yaml" } } }, "request": { "additionalProperties": false, "description": "Specifies your URL health check request.", "type": "object", "required": [ "url" ], "properties": { "edgeLocationId": { "description": "Unique identifier for an edge server location closest to your end users. Run the [List available edge server locations](https://techdocs.akamai.com/edge-diagnostics/reference/get-edge-locations) operation to get this value.", "minLength": 1, "type": "string" }, "ipVersion": { "description": "IP version for the URL health check to use to run cURL and MTR, either `IPV4` or `IPV6`.", "type": "string", "enum": [ "IPV4", "IPV6" ] }, "packetType": { "description": "Packet type for the URL health check to use to run MTR, either `ICMP` or `TCP`. Provide it only for requests with `CONNECTIVITY` in the `viewsAllowed` array.", "type": "string", "enum": [ "ICMP", "TCP" ] }, "port": { "description": "Port number for the URL health check to use to run MTR, either `80` or `443`. Provide it only for requests with `CONNECTIVITY` in the `viewsAllowed` array.", "type": "integer", "enum": [ 80, 443 ] }, "queryType": { "description": "DNS query type you want to get the records of with the DIG command. Possible values are: `A`, `AAAA`, `SOA`, `CNAME`, `PTR`, `MX`, `NS`, `TXT`, `SRV`, `CAA`, and `ANY`. To learn more about them, check [Supported DNS record types](https://techdocs.akamai.com/edge-diagnostics/docs/domain-details-dig#supported-dns-record-types).", "type": "string", "enum": [ "A", "SOA", "CNAME", "PTR", "MX", "AAAA", "NS", "TXT", "SRV", "CAA", "ANY" ] }, "requestHeaders": { "description": "Customized headers for the `curl` request in the format `header: value`. The request includes [Akamai Pragma headers](https://techdocs.akamai.com/edge-diagnostics/docs/pragma-headers) by default.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } }, "runFromSiteShield": { "description": "Runs a URL health check from a Site Shield map. To learn more, check [Site Shield requests](https://techdocs.akamai.com/edge-diagnostics/reference/site-shield-requests).", "type": "boolean" }, "sensitiveRequestHeaderKeys": { "description": "Sensitive `requestHeaders` you don't want to store in the database after running the request. Check [Sensitive headers](https://techdocs.akamai.com/edge-diagnostics/reference/sensitive-headers) to see the list of request headers treated as sensitive by default.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } }, "spoofEdgeIp": { "description": "IP of the edge server you want to serve traffic from. You can use the edge server IP value from the `answerSection` array in the [Get domain details with dig](https://techdocs.akamai.com/edge-diagnostics/reference/post-dig) operation response.", "minLength": 1, "type": "string" }, "url": { "description": "URL you want to run the health check for.", "minLength": 1, "type": "string" }, "viewsAllowed": { "description": "Additional operations for the URL health check to run. `CONNECTIVITY` runs the [Test network connectivity with MTR](https://techdocs.akamai.com/edge-diagnostics/reference/post-mtr) operation and `LOGS` runs the [Get specific logs](https://techdocs.akamai.com/edge-diagnostics/reference/get-grep) operation.", "minItems": 0, "type": "array", "items": { "type": "string", "enum": [ "CONNECTIVITY", "LOGS" ] } } }, "x-akamai": { "file-path": "schemas/urlHealthCheckRequest.yaml" } }, "requestId": { "description": "Unique identifier for the URL health check request. Store this value to run [Get a URL health check response](https://techdocs.akamai.com/edge-diagnostics/reference/get-url-health-check-requests) operation.", "minimum": 0, "type": "integer" }, "retryAfter": { "description": "Number of seconds when the request is estimated to have processed. It occurs only for operations with the `IN_PROGRESS` status.", "minimum": 0, "type": "integer" }, "siteShieldIp": { "description": "If your request specifies `runFromSiteShield` as `true`, then this IP used to run a URL health check.", "minLength": 1, "type": "string" }, "siteShieldIpLocation": { "additionalProperties": false, "description": "Specifies the geolocation of the edge server used to run the operation.", "type": "object", "required": [ "city", "regionCode", "countryCode", "asNumber" ], "properties": { "asNumber": { "description": "Autonomous System Number the edge IP maps to.", "minimum": 0, "type": "integer" }, "city": { "description": "Closest city within a 50-mile radius the edge IP maps to.", "minLength": 1, "type": "string" }, "countryCode": { "description": "ISO 3166 country code the edge IP maps to.", "minLength": 1, "type": "string" }, "regionCode": { "description": "ISO 3166 region code the edge IP maps to.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/edgeIpLocation.yaml" } }, "spoofEdgeIpLocation": { "additionalProperties": false, "description": "Specifies the geolocation of the edge server used to serve the request.", "type": "object", "required": [ "city", "regionCode", "countryCode", "asNumber" ], "properties": { "asNumber": { "description": "Autonomous System Number the edge IP maps to.", "minimum": 0, "type": "integer" }, "city": { "description": "Closest city within a 50-mile radius the edge IP maps to.", "minLength": 1, "type": "string" }, "countryCode": { "description": "ISO 3166 country code the edge IP maps to.", "minLength": 1, "type": "string" }, "regionCode": { "description": "ISO 3166 region code the edge IP maps to.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/edgeIpLocation.yaml" } }, "summary": { "additionalProperties": false, "description": "Specifies [Akamaized URL (ARL)](https://techdocs.akamai.com/edge-diagnostics/docs/arl-syntax) details and partial results of the URL health check. These results contain fetched data that Edge Diagnostics identified as potential source of issues.", "type": "object", "required": [ "edgeServerIp", "content", "domainDetails", "cpCode" ], "properties": { "cacheKeyHostname": { "description": "Cache key hostname.", "format": "hostname", "type": "string" }, "cacheSetting": { "description": "Cache settings.", "minLength": 1, "type": "string" }, "connectivity": { "description": "Lists the results of the MTR request.", "minItems": 0, "type": "array", "items": { "additionalProperties": false, "type": "object", "required": [ "executionStatus", "sourceIpLocation", "destinationIpLocation", "sourceContext", "destinationContext", "executionContext" ], "properties": { "additionalRequestParameters": { "additionalProperties": false, "description": "Specifies the MTR request.", "minProperties": 1, "type": "object", "required": [ "source", "destination" ], "properties": { "destination": { "description": "Destination of the request.", "minLength": 1, "type": "string" }, "ipVersion": { "description": "IP version used by the request, either `IPV4` or `IPV6`.", "type": "string", "enum": [ "IPV4", "IPV6" ] }, "packetType": { "description": "Packet type used by the request, either `ICMP` or `TCP`.", "type": "string", "enum": [ "ICMP", "TCP" ] }, "port": { "description": "Port number used by the request, either `80` or `443`.", "type": "integer", "enum": [ 80, 443 ] }, "source": { "description": "Source of the request.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/additionalMtrRequestParameters.yaml" } }, "destinationContext": { "description": "Whether the destination IP is a `CLIENT_IP` or `ORIGIN_IP`.", "type": "string", "enum": [ "ORIGIN_IP", "CLIENT_IP" ] }, "destinationIpLocation": { "additionalProperties": false, "description": "Specifies the geolocation of the origin server IP.", "type": "object", "required": [ "city", "regionCode", "countryCode", "asNumber" ], "properties": { "asNumber": { "description": "Autonomous System Number the edge IP maps to.", "minimum": 0, "type": "integer" }, "city": { "description": "Closest city within a 50-mile radius the edge IP maps to.", "minLength": 1, "type": "string" }, "countryCode": { "description": "ISO 3166 country code the edge IP maps to.", "minLength": 1, "type": "string" }, "regionCode": { "description": "ISO 3166 region code the edge IP maps to.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/edgeIpLocation.yaml" } }, "errorResponse": { "additionalProperties": false, "description": "Specifies the reason for `FAILURE` status.", "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Details about the error.", "minLength": 1, "type": "string" }, "errors": { "description": "Collects information about problems occurred while fetching the data.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } }, "status": { "description": "Error status code.", "minLength": 1, "type": "string" }, "title": { "description": "Error title.", "minLength": 1, "type": "string" }, "type": { "description": "Error type.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/errorResponse.yaml" } }, "executionContext": { "description": "Execution context for MTR. Edge Diagnostics executes MTR between an edge server and the origin server (`EDGE_IP_TO_ORIGIN_IP`) or, if a client IP is present in the request, between an edge server and the client machine (`EDGE_IP_TO_CLIENT_IP`).", "type": "string", "enum": [ "EDGE_IP_TO_ORIGIN_IP", "EDGE_IP_TO_CLIENT_IP" ] }, "executionStatus": { "description": "Status of the MTR request's execution. Possible values are `SUCCESS`, `FAILURE`, or `NOT_EXECUTED`. The `info` member and `FAILURE` in `errorResponse` provide details for `NOT_EXECUTED`.", "type": "string", "enum": [ "SUCCESS", "FAILURE", "NOT_EXECUTED" ] }, "info": { "additionalProperties": false, "description": "Specifies the reason for `NOT_EXECUTED` status.", "type": "object", "required": [ "key", "message" ], "properties": { "key": { "description": "Error key.", "minLength": 1, "type": "string" }, "message": { "description": "Details about the error.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/info.yaml" } }, "result": { "additionalProperties": false, "description": "Standard MTR results.", "type": "object", "required": [ "startTime", "host", "packetLoss", "averageLatency", "hops", "result" ], "properties": { "averageLatency": { "description": "Average latency for all hops, in seconds.", "minimum": 0, "type": "number" }, "hops": { "description": "Lists network hops with their data.", "minItems": 0, "type": "array", "items": { "additionalProperties": false, "description": "Collects network hops with their data.", "type": "object", "required": [ "number", "host", "ip", "ipLocation", "packetLoss", "sentPackets", "lastPacketLatency", "averageLatency", "bestRtt", "worstRtt", "standardDeviation" ], "properties": { "averageLatency": { "description": "Average hop value, useful to detect ongoing problems.", "minimum": 0, "type": "number" }, "bestRtt": { "description": "Fastest time, in milliseconds.", "minimum": 0, "type": "number" }, "host": { "description": "Host or domain name for the hop.", "minLength": 1, "type": "string" }, "ip": { "description": "IP of the hop's `edgeHost`.", "minLength": 1, "type": "string" }, "ipLocation": { "additionalProperties": false, "description": "Geolocation data for the hop's `edgeHost`.", "type": "object", "required": [ "city", "regionCode", "countryCode", "asNumber" ], "properties": { "asNumber": { "description": "Autonomous System Number the edge IP maps to.", "minimum": 0, "type": "integer" }, "city": { "description": "Closest city within a 50-mile radius the edge IP maps to.", "minLength": 1, "type": "string" }, "countryCode": { "description": "ISO 3166 country code the edge IP maps to.", "minLength": 1, "type": "string" }, "regionCode": { "description": "ISO 3166 region code the edge IP maps to.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/edgeIpLocation.yaml" } }, "lastPacketLatency": { "description": "Last measured hop value, useful to detect ongoing problems.", "minimum": 0, "type": "number" }, "number": { "description": "Index for each hop's count within the full set.", "minimum": 0, "type": "integer" }, "packetLoss": { "description": "Percentage of packets lost for the hop, maximum `100`.", "maximum": 100, "minimum": 0, "type": "number" }, "sentPackets": { "description": "Number of packets sent for the hop.", "minimum": 0, "type": "integer" }, "standardDeviation": { "description": "Standard deviation, in milliseconds.", "minimum": 0, "type": "number" }, "worstRtt": { "description": "Slowest time, in milliseconds.", "minimum": 0, "type": "number" } }, "x-akamai": { "file-path": "schemas/mtrHopInstance.yaml" } } }, "host": { "description": "Hostname within the edge network that corresponds to the `source` IP address.", "format": "hostname", "type": "string" }, "packetLoss": { "description": "Percentage of packets lost, maximum `100`.", "maximum": 100, "minimum": 0, "type": "number" }, "result": { "description": "Raw MTR utility output.", "minLength": 1, "type": "string" }, "startTime": { "description": "Epoch timestamp marking when MTR was run.", "type": "integer" } }, "x-akamai": { "file-path": "schemas/mtrData.yaml" } }, "sourceContext": { "description": "Context for MTR source. The source can be either an edge server forwarding the request to the origin server (`EDGE_IP_CONNECTED_TO_ORIGIN`) or an edge server in the location (`EDGE_IP_BASED_ON_LOCATION`), either selected randomly or provided in the request.", "type": "string", "enum": [ "EDGE_IP_CONNECTED_TO_ORIGIN", "EDGE_IP_BASED_ON_LOCATION" ] }, "sourceIpLocation": { "additionalProperties": false, "description": "Specifies the geolocation of the source IP.", "type": "object", "required": [ "city", "regionCode", "countryCode", "asNumber" ], "properties": { "asNumber": { "description": "Autonomous System Number the edge IP maps to.", "minimum": 0, "type": "integer" }, "city": { "description": "Closest city within a 50-mile radius the edge IP maps to.", "minLength": 1, "type": "string" }, "countryCode": { "description": "ISO 3166 country code the edge IP maps to.", "minLength": 1, "type": "string" }, "regionCode": { "description": "ISO 3166 region code the edge IP maps to.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/edgeIpLocation.yaml" } }, "suggestedActions": { "description": "Suggestions on what to do next with the results.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } } }, "x-akamai": { "file-path": "schemas/connectivity.yaml" } } }, "content": { "description": "Lists the results of the cURL request.", "minItems": 0, "type": "array", "items": { "additionalProperties": false, "type": "object", "required": [ "executionContext", "executionStatus" ], "properties": { "additionalRequestParameters": { "additionalProperties": false, "description": "Specifies the cURL request.", "minProperties": 1, "type": "object", "properties": { "includeDefaultPragmaHeaders": { "description": "Indicates whether the request included the default list of `Pragma` headers. Check [Pragma headers](https://techdocs.akamai.com/edge-diagnostics/docs/pragma-headers) to learn about default Akamai Pragma headers.", "type": "boolean" }, "ipVersion": { "description": "IP version used by the request, either `IPV4` or `IPV6`.", "type": "string", "enum": [ "IPV4", "IPV6" ] }, "requestHeaders": { "description": "Customized headers for `curl` request in the format `header: value`.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } } }, "x-akamai": { "file-path": "schemas/additionalCurlRequestParameters.yaml" } }, "errorResponse": { "additionalProperties": false, "description": "Specifies the reason for `FAILURE` status.", "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Details about the error.", "minLength": 1, "type": "string" }, "errors": { "description": "Collects information about problems occurred while fetching the data.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } }, "status": { "description": "Error status code.", "minLength": 1, "type": "string" }, "title": { "description": "Error title.", "minLength": 1, "type": "string" }, "type": { "description": "Error type.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/errorResponse.yaml" } }, "executionContext": { "description": "Execution context. The only possible value is `DEFAULT`. For now, this member doesn't provide any meaningful data.", "type": "string", "enum": [ "DEFAULT" ] }, "executionStatus": { "description": "Status of the cURL request's execution, either `SUCCESS` or `FAILURE`.", "type": "string", "enum": [ "SUCCESS", "FAILURE" ] }, "result": { "additionalProperties": false, "description": "Results of the `curl` command.", "minProperties": 1, "type": "object", "required": [ "exitCode" ], "properties": { "exitCode": { "description": "Curl command exit code. [List of possible curl exit code.](https://curl.se/libcurl/c/libcurl-errors.html) ", "minimum": 0, "type": "integer" }, "httpStatusCode": { "description": "Returned HTTP response code.", "maximum": 599, "minimum": 100, "type": "integer" }, "httpVersion": { "description": "HTTP version used for `curl`.", "minLength": 1, "type": "string" }, "reasonPhrase": { "description": "Reason phrase for the response.", "minLength": 1, "type": "string" }, "responseBody": { "description": "Entire response body.", "minLength": 1, "type": "string" }, "responseHeaderList": { "description": "Collects the response headers in the format `header: value`.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } }, "timing": { "additionalProperties": false, "description": "Collects the time related data.", "type": "object", "required": [ "dnsLookupTime", "tcpConnectionTime", "sslConnectionTime", "timeToFirstByte", "totalTime" ], "properties": { "dnsLookupTime": { "description": "DNS lookup time, in seconds.", "minimum": 0, "type": "number" }, "sslConnectionTime": { "description": "SSL connection time, in seconds.", "minimum": 0, "type": "number" }, "tcpConnectionTime": { "description": "TCP connection time, in seconds.", "minimum": 0, "type": "number" }, "timeToFirstByte": { "description": "Time to first byte, in seconds.", "minimum": 0, "type": "number" }, "totalTime": { "description": "Total time, in seconds.", "minimum": 0, "type": "number" } } } }, "x-akamai": { "file-path": "schemas/curlResults.yaml" } }, "suggestedActions": { "description": "Suggestions on what to do next with the results.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } } }, "x-akamai": { "file-path": "schemas/contentDetail.yaml" } } }, "cpCode": { "description": "CP code that applies to the URL of the request.", "minimum": 1, "type": "integer" }, "domainDetails": { "description": "Lists the results of the DIG request.", "minItems": 0, "type": "array", "items": { "additionalProperties": false, "type": "object", "required": [ "executionStatus" ], "properties": { "additionalRequestParameters": { "additionalProperties": false, "description": "Specifies the DIG request.", "minProperties": 1, "type": "object", "properties": { "queryType": { "description": "DNS query type fetched by the request. Possible values are: `A`, `AAAA`, `SOA`, `CNAME`, `PTR`, `MX`, `NS`, `TXT`, `SRV`, `CAA`, and `ANY`. To learn more about them, check [Supported DNS record types](https://techdocs.akamai.com/edge-diagnostics/docs/domain-details-dig#supported-dns-record-types).", "type": "string", "enum": [ "A", "SOA", "CNAME", "PTR", "MX", "AAAA", "NS", "TXT", "SRV", "CAA", "ANY" ] } }, "x-akamai": { "file-path": "schemas/additionalDigRequestParameters.yaml" } }, "errorResponse": { "additionalProperties": false, "description": "Specifies the reason for `FAILURE` status.", "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Details about the error.", "minLength": 1, "type": "string" }, "errors": { "description": "Collects information about problems occurred while fetching the data.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } }, "status": { "description": "Error status code.", "minLength": 1, "type": "string" }, "title": { "description": "Error title.", "minLength": 1, "type": "string" }, "type": { "description": "Error type.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/errorResponse.yaml" } }, "executionContext": { "description": "Execution context. The only possible value is `DEFAULT`. For now, this member doesn't provide any meaningful data.", "type": "string", "enum": [ "DEFAULT" ] }, "executionStatus": { "description": "Status of the DIG request's execution, either `SUCCESS` or `FAILURE`.", "type": "string", "enum": [ "SUCCESS", "FAILURE" ] }, "result": { "additionalProperties": false, "description": "Standard `dig` response.", "type": "object", "required": [ "result" ], "properties": { "answerSection": { "description": "Collects a DNS record of answering servers.", "minItems": 1, "type": "array", "items": { "additionalProperties": false, "description": "Specifies a DNS record that appears within a response of the [Get domain details with dig](https://techdocs.akamai.com/edge-diagnostics/reference/post-dig) operation, in `answerSection` or `authoritySection`.", "type": "object", "properties": { "domain": { "description": "Domain name for this record.", "minLength": 1, "type": "string" }, "hostname": { "description": "Hostname you requested the data for.", "format": "hostname", "type": "string" }, "preferenceValue": { "description": "Preference value, only valid for records of the `MX` type, otherwise `null`.", "minimum": 0, "nullable": true, "type": "integer" }, "recordClass": { "description": "Class of the record, typically `IN` for *internet*.", "minLength": 1, "type": "string" }, "recordType": { "description": "Requested record type. Possible values are: `A`, `AAAA`, `SOA`, `CNAME`, `PTR`, `MX`, `NS`, `TXT`, `SRV`, `CAA`, and `ANY`. To learn more about them, check [Supported DNS record types](https://techdocs.akamai.com/edge-diagnostics/docs/domain-details-dig#supported-dns-record-types).", "type": "string", "enum": [ "A", "AAAA", "SOA", "CNAME", "PTR", "MX", "NS", "TXT", "SRV", "CAA", "ANY" ] }, "ttl": { "description": "Server's default number of seconds to keep content cached.", "minimum": 0, "type": "integer" }, "value": { "description": "Record's value, either another domain or a final IP address.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/dnsRecord.yaml" }, "oneOf": [ { "title": "Hostname required", "required": [ "hostname", "ttl", "recordClass", "recordType", "value" ] }, { "title": "Domain required", "required": [ "domain", "ttl", "recordClass", "recordType", "value" ] } ] } }, "authoritySection": { "description": "Collects a DNS record of servers authorized to answer.", "minItems": 1, "type": "array", "items": { "additionalProperties": false, "description": "Specifies a DNS record that appears within a response of the [Get domain details with dig](https://techdocs.akamai.com/edge-diagnostics/reference/post-dig) operation, in `answerSection` or `authoritySection`.", "type": "object", "properties": { "domain": { "description": "Domain name for this record.", "minLength": 1, "type": "string" }, "hostname": { "description": "Hostname you requested the data for.", "format": "hostname", "type": "string" }, "preferenceValue": { "description": "Preference value, only valid for records of the `MX` type, otherwise `null`.", "minimum": 0, "nullable": true, "type": "integer" }, "recordClass": { "description": "Class of the record, typically `IN` for *internet*.", "minLength": 1, "type": "string" }, "recordType": { "description": "Requested record type. Possible values are: `A`, `AAAA`, `SOA`, `CNAME`, `PTR`, `MX`, `NS`, `TXT`, `SRV`, `CAA`, and `ANY`. To learn more about them, check [Supported DNS record types](https://techdocs.akamai.com/edge-diagnostics/docs/domain-details-dig#supported-dns-record-types).", "type": "string", "enum": [ "A", "AAAA", "SOA", "CNAME", "PTR", "MX", "NS", "TXT", "SRV", "CAA", "ANY" ] }, "ttl": { "description": "Server's default number of seconds to keep content cached.", "minimum": 0, "type": "integer" }, "value": { "description": "Record's value, either another domain or a final IP address.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/dnsRecord.yaml" }, "oneOf": [ { "title": "Hostname required", "required": [ "hostname", "ttl", "recordClass", "recordType", "value" ] }, { "title": "Domain required", "required": [ "domain", "ttl", "recordClass", "recordType", "value" ] } ] } }, "result": { "description": "Raw `dig` output.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/digInfo.yaml" } }, "suggestedActions": { "description": "Suggestions on what to do next with the results.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } } }, "x-akamai": { "file-path": "schemas/domainDetail.yaml" } } }, "edgeServerIp": { "description": "IP of the edge server used to serve the request.", "minLength": 1, "type": "string" }, "edgeStatusCode": { "description": "HTTP status code returned by the edge server.", "minLength": 1, "type": "string" }, "errorMessage": { "description": "Error message.", "minLength": 1, "type": "string" }, "logLines": { "description": "Lists the results of the GREP request.", "minItems": 0, "type": "array", "items": { "additionalProperties": false, "description": "Collects fetched logs.", "type": "object", "required": [ "executionContext", "executionStatus" ], "properties": { "errorResponse": { "additionalProperties": false, "description": "Specifies the reason for `FAILURE` status.", "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Details about the error.", "minLength": 1, "type": "string" }, "errors": { "description": "Collects information about problems occurred while fetching the data.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } }, "status": { "description": "Error status code.", "minLength": 1, "type": "string" }, "title": { "description": "Error title.", "minLength": 1, "type": "string" }, "type": { "description": "Error type.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/errorResponse.yaml" } }, "executionContext": { "description": "Execution context. The only possible value is `DEFAULT`. For now, this member doesn't provide any meaningful data.", "type": "string", "enum": [ "DEFAULT" ] }, "executionStatus": { "description": "Status of the GREP request's execution, either `SUCCESS` or `FAILURE`.", "type": "string", "enum": [ "SUCCESS", "FAILURE" ] }, "result": { "additionalProperties": false, "description": "Provides logs fetched with the GREP command.", "type": "object", "required": [ "logs", "legend" ], "properties": { "legend": { "additionalProperties": false, "description": "Descriptions of returned `logType`, `objectStatus`, `objectStatus2`, `objectStatus3` in `r` and `f` log lines.", "type": "object", "required": [ "logType", "rObjectStatus", "rObjectStatus2", "rObjectStatus3", "fObjectStatus", "fObjectStatus2", "fObjectStatus3" ], "properties": { "fObjectStatus": { "description": "Descriptions of the `objectStatus` data in f-line.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } }, "fObjectStatus2": { "description": "Descriptions of the `objectStatus2` data in f-line.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } }, "fObjectStatus3": { "description": "Descriptions of the `objectStatus3` data in f-line.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } }, "logType": { "description": "Description of the `logType` data.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } }, "rObjectStatus": { "description": "Descriptions of the `objectStatus` data in r-line.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } }, "rObjectStatus2": { "description": "Descriptions of the `objectStatus2` data in r-line.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } }, "rObjectStatus3": { "description": "Descriptions of the `objectStatus3` data in r-line.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } } }, "x-akamai": { "file-path": "schemas/legend.yaml" } }, "logs": { "description": "Filtered log lines.", "minItems": 0, "type": "array", "items": { "description": "Items provided as key/value pairs.", "type": "object", "x-akamai": { "file-path": "schemas/fields.yaml" } } } }, "x-akamai": { "file-path": "schemas/logsContainer.yaml" } }, "suggestedActions": { "description": "Suggestions on what to do next with the results.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } } }, "x-akamai": { "file-path": "schemas/logLines.yaml" } } }, "originResponseCode": { "description": "HTTP status code returned by the origin server.", "minLength": 1, "type": "string" }, "originServerHostname": { "description": "Origin server hostname.", "format": "hostname", "type": "string" }, "originServerIp": { "description": "IP of the origin server used to serve the request.", "minLength": 1, "type": "string" }, "serialNumber": { "description": "Unique identifier for a server mapped to a region.", "minLength": 1, "type": "string" }, "ttl": { "description": "Remaining number of seconds to keep content cached, either a specific number or `Infinite`.", "minLength": 1, "type": "string" }, "typeCode": { "description": "Description of the server configuration.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/urlHealthCheckSummary.yaml" } } }, "x-akamai": { "file-path": "schemas/urlHealthCheckResponse.yaml" } } } }, "headers": { "X-RateLimit-Limit": { "description": "The rate limit ceiling for this endpoint.", "example": 10, "schema": { "type": "integer" }, "x-akamai": { "file-path": "headers/X-RateLimit-Limit.yaml" } }, "X-RateLimit-Remaining": { "description": "The number of requests left for the time window.", "example": 5, "schema": { "type": "integer" }, "x-akamai": { "file-path": "headers/X-RateLimit-Remaining.yaml" } } } }, "401": { "description": "[Authorization error](https://techdocs.akamai.com/edge-diagnostics/reference/401).", "content": { "application/problem+json": { "example": { "detail": "Inactive client token", "instance": "https://akab-nedrvuylepskzabx-lv3dgceqqktx3i5b.luna.akamaiapis.net/edge-diagnostics/v1/grep/requests", "status": 401, "title": "Not authorized", "type": "https://problems.luna.akamaiapis.net/-/pep-authn/deny" }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/401.yaml" } }, "403": { "description": "[Permission error](https://techdocs.akamai.com/edge-diagnostics/reference/403).", "content": { "application/problem+json": { "example": { "status": 403, "title": "Forbidden request.", "type": "forbidden.request.error", "errors": [ { "detail": "You don't have access to the requested URL. Contact your Admin to request access.", "requestField": "url", "title": "Field access denied.", "type": "field.access.denied" } ] }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/403.yaml" } }, "404": { "description": "[Resource not found error](https://techdocs.akamai.com/edge-diagnostics/reference/404).", "content": { "application/problem+json": { "example": { "detail": "The requested resource couldn't be found. Make sure that the resource is not deleted and the ID is correct.", "status": 404, "title": "Resource not found.", "type": "resource.not.found" }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/404.yaml" } }, "405": { "description": "[Method not allowed](https://techdocs.akamai.com/edge-diagnostics/reference/405).", "content": { "application/problem+json": { "example": { "title": "Method not allowed", "type": "method.not.allowed" }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/405.yaml" } }, "429": { "description": "[Too many requests](https://techdocs.akamai.com/edge-diagnostics/reference/429).", "content": { "application/problem+json": { "example": { "detail": "You have exceeded total number of requests configured for this API.", "status": 429, "title": "Too Many Requests", "type": "requests.exceeded.error" }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/429.yaml" } } }, "parameters": [ { "description": "Includes response bodies in the response.", "example": "{{includeContentResponseBody}}", "in": "query", "name": "includeContentResponseBody", "schema": { "example": false, "type": "boolean" }, "x-akamai": { "file-path": "parameters/includeContentResponseBody-query.yaml" } }, { "description": "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ] }, "parameters": [ { "description": "Unique identifier for a request. To get this value, run the corresponding POST operation.", "example": "{{requestId}}", "in": "path", "name": "requestId", "required": true, "schema": { "example": 365, "type": "integer" }, "x-akamai": { "file-path": "parameters/requestId-path.yaml" } } ] }, "/user-diagnostic-data/groups": { "post": { "description": "Generates a diagnostic link for you to share with end users of a particular URL or IP acceleration hostname experiencing similar issues. After an end user clicks the link, the tool gathers necessary diagnostic data and asks the end user to submit it. Once submitted, you can check the collected data with the [Get diagnostic data of a group](https://techdocs.akamai.com/edge-diagnostics/reference/get-user-diagnostic-data-group-records) operation. Each link is valid for 7 days of 50 submissions. To get the list of IP acceleration hostname you can collect diagnostic data for, run the [List IP acceleration hostnames](https://techdocs.akamai.com/edge-diagnostics/reference/get-ipa-hostnames) operation first.", "operationId": "post-user-diagnostic-data-groups", "summary": "Generate a diagnostic link", "tags": [ "User diagnostic data" ], "externalDocs": { "description": "See documentation for this operation in Akamai's Edge Diagnostics API", "url": "https://techdocs.akamai.com/edge-diagnostics/reference/post-user-diagnostic-data-groups" }, "requestBody": { "required": true, "content": { "application/json": { "example": { "note": "Diagnostic group", "url": "https://www.example.com" }, "schema": { "additionalProperties": false, "description": "Collects data necessary to generate a diagnostic link for you to send to end users to gather diagnostic data.", "type": "object", "properties": { "ipaHostname": { "description": "IP acceleration hostname you want to collect the diagnostic data for. You need to provide either this value or `url`. To get the available hostnames, run the [List IP acceleration hostnames](https://techdocs.akamai.com/edge-diagnostics/reference/get-ipa-hostnames) operation.", "example": "{{ipaHostname}}", "format": "hostname", "type": "string" }, "note": { "description": "Notes about the group or issues experienced by group's end users. ", "example": "{{note}}", "minLength": 1, "type": "string" }, "url": { "description": "URL you want to collect the diagnostic data for. You need to provide either this value or `ipaHostname`.", "example": "{{url}}", "format": "uri", "type": "string" } }, "x-akamai": { "file-path": "schemas/userDiagnosticDataGroupsPostRequest.yaml" }, "oneOf": [ { "title": "URL request", "required": [ "url" ] }, { "title": "IPA hostname request", "required": [ "ipaHostname" ] } ] } } } }, "responses": { "201": { "description": "Diagnostic link successfully created.", "content": { "application/json": { "example": { "createdBy": "jkowalski", "createdTime": "2021-07-24T04:25:40Z", "diagnosticLink": "www.t1info.net/623b8c", "diagnosticLinkStatus": "ACTIVE", "groupId": "623b8c", "note": "Diagnostic group", "recordCount": 0, "url": "https://www.example.com" }, "schema": { "additionalProperties": false, "description": "Specifies a group and a diagnostic link which can be sent to users to collect diagnostic data.", "type": "object", "properties": { "createdBy": { "description": "Username who generated the diagnostic link.", "minLength": 1, "type": "string" }, "createdTime": { "description": "ISO 8601 timestamp indicating when the request was submitted.", "format": "date-time", "type": "string" }, "diagnosticLink": { "description": "Diagnostic link generated to share with end users to collect diagnostic data. Each link is valid for 7 days or 50 submissions.", "minLength": 1, "type": "string" }, "diagnosticLinkStatus": { "description": "Status of `diagnosticLink`. The possible values are either `ACTIVE` or `EXPIRED`. The `ACTIVE` link can be send to users to collect diagnostic data. The `EXPIRED` link is older than 7 days or has reached the limit of 50 submission. You can't collect more data with the `EXPIRED` link.", "type": "string", "enum": [ "ACTIVE", "EXPIRED" ] }, "groupId": { "description": "Unique identifier for the group. Store this value to get the collected data using the [Get diagnostic data of a group](https://techdocs.akamai.com/edge-diagnostics/reference/get-user-diagnostic-data-group-records) operation.", "minLength": 1, "type": "string" }, "ipaHostname": { "description": "IP acceleration hostname you collected the diagnostic data for. Depending on the request, the response contains either this value or `url`.", "format": "hostname", "type": "string" }, "note": { "description": "Notes about the group or issues experienced by group's end users.", "minLength": 1, "type": "string" }, "recordCount": { "description": "Number of diagnostic data submitted with `diagnosticLink`.", "minimum": 0, "type": "integer" }, "url": { "description": "URL you collected the diagnostic data for. Depending on the request, the response contains either this value or `ipaHostname`.", "format": "uri", "type": "string" } }, "x-akamai": { "file-path": "schemas/userDiagnosticDataGroupsPostResponse.yaml" }, "oneOf": [ { "title": "URL request", "required": [ "url", "groupId", "createdBy", "createdTime", "diagnosticLink", "diagnosticLinkStatus", "recordCount" ] }, { "title": "IPA hostname request", "required": [ "ipaHostname", "groupId", "createdBy", "createdTime", "diagnosticLink", "diagnosticLinkStatus", "recordCount" ] } ] } } }, "headers": { "Location": { "description": "Provides a URL path you can GET the newly created resource from.", "schema": { "type": "string" }, "x-akamai": { "file-path": "headers/Location.yaml" } }, "X-RateLimit-Limit": { "description": "The rate limit ceiling for this endpoint.", "example": 10, "schema": { "type": "integer" }, "x-akamai": { "file-path": "headers/X-RateLimit-Limit.yaml" } }, "X-RateLimit-Remaining": { "description": "The number of requests left for the time window.", "example": 5, "schema": { "type": "integer" }, "x-akamai": { "file-path": "headers/X-RateLimit-Remaining.yaml" } } } }, "400": { "description": "[Validation error](https://techdocs.akamai.com/edge-diagnostics/reference/400).", "content": { "application/problem+json": { "example": { "detail": "Provide only one of these members, either `edgeLocationId` or `edgeIp`.", "status": 400, "title": "Incorrect request.", "type": "bad.request.error", "errors": [ { "requestField": "edgeLocationId", "title": "Conflicting values.", "type": "field.conflict" }, { "requestField": "edgeIp", "title": "Conflicting values.", "type": "field.conflict" } ] }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/400.yaml" } }, "401": { "description": "[Authorization error](https://techdocs.akamai.com/edge-diagnostics/reference/401).", "content": { "application/problem+json": { "example": { "detail": "Inactive client token", "instance": "https://akab-nedrvuylepskzabx-lv3dgceqqktx3i5b.luna.akamaiapis.net/edge-diagnostics/v1/grep/requests", "status": 401, "title": "Not authorized", "type": "https://problems.luna.akamaiapis.net/-/pep-authn/deny" }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/401.yaml" } }, "403": { "description": "[Permission error](https://techdocs.akamai.com/edge-diagnostics/reference/403).", "content": { "application/problem+json": { "example": { "status": 403, "title": "Forbidden request.", "type": "forbidden.request.error", "errors": [ { "detail": "You don't have access to the requested URL. Contact your Admin to request access.", "requestField": "url", "title": "Field access denied.", "type": "field.access.denied" } ] }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/403.yaml" } }, "405": { "description": "[Method not allowed](https://techdocs.akamai.com/edge-diagnostics/reference/405).", "content": { "application/problem+json": { "example": { "title": "Method not allowed", "type": "method.not.allowed" }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/405.yaml" } }, "429": { "description": "[Too many requests](https://techdocs.akamai.com/edge-diagnostics/reference/429).", "content": { "application/problem+json": { "example": { "detail": "You have exceeded total number of requests configured for this API.", "status": 429, "title": "Too Many Requests", "type": "requests.exceeded.error" }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/429.yaml" } } }, "parameters": [ { "description": "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ] }, "get": { "description": "Lists groups created for collecting diagnostic data and their details. A group stores diagnostic data of end users of a particular domain experiencing similar issues submitted with the specific diagnostic link. To create the diagnostic link, run the [Generate a diagnostic link](https://techdocs.akamai.com/edge-diagnostics/reference/post-user-diagnostic-data-groups) operation. To check the data collected for a group, store the returned `groupId` value and use it to run the [Get diagnostic data of a group](https://techdocs.akamai.com/edge-diagnostics/reference/get-user-diagnostic-data-group-records) operation.", "operationId": "get-user-diagnostic-data-groups", "summary": "List end user groups", "tags": [ "User diagnostic data" ], "externalDocs": { "description": "See documentation for this operation in Akamai's Edge Diagnostics API", "url": "https://techdocs.akamai.com/edge-diagnostics/reference/get-user-diagnostic-data-groups" }, "responses": { "200": { "description": "The response lists created diagnostic groups and their details.", "content": { "application/json": { "example": { "groups": [ { "createdBy": "tyamada", "createdTime": "2021-07-24T04:25:40Z", "diagnosticLink": "www.t1info.net/623b8c", "diagnosticLinkStatus": "ACTIVE", "groupId": "623b8c", "note": "Diagnostic group", "recordCount": 0, "url": "https://www.example.com" } ] }, "schema": { "additionalProperties": false, "description": "Collects all groups created to gather diagnostic data within the top-level object's `groups` member.", "type": "object", "required": [ "groups" ], "properties": { "groups": { "description": "Lists groups created to gather diagnostic data and their details.", "minItems": 0, "type": "array", "items": { "additionalProperties": false, "description": "Specifies a group and a diagnostic link which can be sent to users to collect diagnostic data.", "type": "object", "properties": { "createdBy": { "description": "Username who generated the diagnostic link.", "minLength": 1, "type": "string" }, "createdTime": { "description": "ISO 8601 timestamp indicating when the request was submitted.", "format": "date-time", "type": "string" }, "diagnosticLink": { "description": "Diagnostic link generated to share with end users to collect diagnostic data. Each link is valid for 7 days or 50 submissions.", "minLength": 1, "type": "string" }, "diagnosticLinkStatus": { "description": "Status of `diagnosticLink`. The possible values are either `ACTIVE` or `EXPIRED`. The `ACTIVE` link can be send to users to collect diagnostic data. The `EXPIRED` link is older than 7 days or has reached the limit of 50 submission. You can't collect more data with the `EXPIRED` link.", "type": "string", "enum": [ "ACTIVE", "EXPIRED" ] }, "groupId": { "description": "Unique identifier for the group. Store this value to get the collected data using the [Get diagnostic data of a group](https://techdocs.akamai.com/edge-diagnostics/reference/get-user-diagnostic-data-group-records) operation.", "minLength": 1, "type": "string" }, "ipaHostname": { "description": "IP acceleration hostname you collected the diagnostic data for. Depending on the request, the response contains either this value or `url`.", "format": "hostname", "type": "string" }, "note": { "description": "Notes about the group or issues experienced by group's end users.", "minLength": 1, "type": "string" }, "recordCount": { "description": "Number of diagnostic data submitted with `diagnosticLink`.", "minimum": 0, "type": "integer" }, "url": { "description": "URL you collected the diagnostic data for. Depending on the request, the response contains either this value or `ipaHostname`.", "format": "uri", "type": "string" } }, "x-akamai": { "file-path": "schemas/userDiagnosticDataGroupsPostResponse.yaml" }, "oneOf": [ { "title": "URL request", "required": [ "url", "groupId", "createdBy", "createdTime", "diagnosticLink", "diagnosticLinkStatus", "recordCount" ] }, { "title": "IPA hostname request", "required": [ "ipaHostname", "groupId", "createdBy", "createdTime", "diagnosticLink", "diagnosticLinkStatus", "recordCount" ] } ] } } }, "x-akamai": { "file-path": "schemas/userDiagnosticDataGroupsGetResponse.yaml" } } } }, "headers": { "X-RateLimit-Limit": { "description": "The rate limit ceiling for this endpoint.", "example": 10, "schema": { "type": "integer" }, "x-akamai": { "file-path": "headers/X-RateLimit-Limit.yaml" } }, "X-RateLimit-Remaining": { "description": "The number of requests left for the time window.", "example": 5, "schema": { "type": "integer" }, "x-akamai": { "file-path": "headers/X-RateLimit-Remaining.yaml" } } } }, "401": { "description": "[Authorization error](https://techdocs.akamai.com/edge-diagnostics/reference/401).", "content": { "application/problem+json": { "example": { "detail": "Inactive client token", "instance": "https://akab-nedrvuylepskzabx-lv3dgceqqktx3i5b.luna.akamaiapis.net/edge-diagnostics/v1/grep/requests", "status": 401, "title": "Not authorized", "type": "https://problems.luna.akamaiapis.net/-/pep-authn/deny" }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/401.yaml" } }, "403": { "description": "[Permission error](https://techdocs.akamai.com/edge-diagnostics/reference/403).", "content": { "application/problem+json": { "example": { "status": 403, "title": "Forbidden request.", "type": "forbidden.request.error", "errors": [ { "detail": "You don't have access to the requested URL. Contact your Admin to request access.", "requestField": "url", "title": "Field access denied.", "type": "field.access.denied" } ] }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/403.yaml" } }, "405": { "description": "[Method not allowed](https://techdocs.akamai.com/edge-diagnostics/reference/405).", "content": { "application/problem+json": { "example": { "title": "Method not allowed", "type": "method.not.allowed" }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/405.yaml" } }, "429": { "description": "[Too many requests](https://techdocs.akamai.com/edge-diagnostics/reference/429).", "content": { "application/problem+json": { "example": { "detail": "You have exceeded total number of requests configured for this API.", "status": 429, "title": "Too Many Requests", "type": "requests.exceeded.error" }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/429.yaml" } } }, "parameters": [ { "description": "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ] } }, "/user-diagnostic-data/groups/{groupId}/records": { "get": { "description": "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](https://techdocs.akamai.com/edge-diagnostics/reference/get-user-diagnostic-data-groups) operation first.", "operationId": "get-user-diagnostic-data-group-records", "summary": "Get diagnostic data for an end user group", "tags": [ "User diagnostic data" ], "externalDocs": { "description": "See documentation for this operation in Akamai's Edge Diagnostics API", "url": "https://techdocs.akamai.com/edge-diagnostics/reference/get-user-diagnostic-data-group-records" }, "responses": { "200": { "description": "The response provides diagnostic data for a group.", "content": { "application/json": { "example": { "createdBy": "adevi", "createdTime": "2021-07-24T04:25:40Z", "diagnosticLink": "www.t1info.net/623b8c", "diagnosticLinkStatus": "ACTIVE", "expiryTime": "2021-07-31T04:25:40Z", "groupId": "623b8c", "note": "Diagnostic group", "submissionsRemaining": 49, "url": "https://www.example.com", "records": [ { "cipher": "tls1.3/TLS_AES_256_GCM_SHA384", "cookie": true, "createdEpoch": 1625652686, "createdTime": "2021-07-24T04:25:40Z", "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", "clientDnsIpv4": { "id": 1357, "ip": "2001.db8..3/33", "ipType": "DNS_IPV4", "ipLocation": { "asNumber": 9498, "city": "BANGALORE", "countryCode": "IN", "regionCode": "KA" } }, "clientDnsIpv6": { "ecs": "192.0.2.12/24", "id": 1359, "ip": "2001:db8::1", "ipType": "DNS_IPV6", "ipLocation": { "asNumber": 20940, "city": "CHENNAI", "countryCode": "IN", "regionCode": "TN" } }, "clientIpv4": { "associatedDnsId": 1362, "id": 1363, "ip": "192.0.2.6", "ipType": "CLIENT_IPV4", "ipLocation": { "asNumber": 9583, "city": "BANGALORE", "countryCode": "IN", "regionCode": "KA" } }, "clientIpv6": { "associatedDnsId": 1362, "id": 1364, "ip": "2001:db8::2", "ipType": "CLIENT_IPV6", "ipLocation": { "asNumber": 9583, "city": "BANGALORE", "countryCode": "IN", "regionCode": "KA" } }, "preferredClientIp": { "associatedDnsId": 1359, "id": 1360, "ip": "2001:db8::2", "ipType": "PREFERRED_CLIENT_IP", "ipLocation": { "asNumber": 9583, "city": "BANGALORE", "countryCode": "IN", "regionCode": "KA" } }, "curlResults": [ { "createdBy": "jsmith", "createdTime": "2021-07-07T10:11:36Z", "executionStatus": "SUCCESS", "internalIp": "192.0.2.3", "regionId": 24958, "requestId": 164, "request": { "ipVersion": "IPV4", "url": "https://www.example.com", "edgeIds": [ 1358 ], "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" ] }, "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": "tyamada", "createdTime": "2021-07-07T10:11:36Z", "executionStatus": "SUCCESS", "internalIp": "192.0.2.3", "regionId": 24958, "requestId": 164, "request": { "hostname": "www.example.com", "queryType": "A", "edgeIds": [ 1358 ] }, "result": { "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", "answerSection": [ { "hostname": "www.example.com.", "preferenceValue": null, "recordClass": "IN", "recordType": "CNAME", "ttl": 300, "value": "stls.adobe.com-cn.edgesuite.net." } ] } } ], "edgeIps": [ { "associatedDnsId": 1357, "id": 1358, "ip": "192.0.2.4", "ipType": "EDGE_IP", "regionId": 24958, "ipLocation": { "asNumber": 9498, "city": "BANGALORE", "countryCode": "IN", "regionCode": "KA" } } ], "mtrResults": [ { "createdBy": "mrossi", "createdTime": "2021-07-07T10:11:36Z", "executionStatus": "SUCCESS", "regionId": 24958, "requestId": 164, "sourceInternalIp": "192.0.2.3", "request": { "destinationId": 1360, "ipVersion": "IPV6", "packetType": "TCP", "port": 80, "sourceIds": [ 1358 ] }, "result": { "averageLatency": 0, "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, "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 } ] } } ] } ] }, "schema": { "additionalProperties": false, "description": "Collects diagnostic data collected with a diagnostic link and details about the group.", "type": "object", "properties": { "createdBy": { "description": "Username who generated `diagnosticLink`.", "minLength": 1, "type": "string" }, "createdTime": { "description": "ISO 8601 timestamp indicating when `diagnosticLink` was generated.", "format": "date-time", "type": "string" }, "diagnosticLink": { "description": "Diagnostic link generated to share with end users to collect diagnostic data. Each link is valid for 7 days or 50 submissions.", "minLength": 1, "type": "string" }, "diagnosticLinkStatus": { "description": "Status of `diagnosticLink`. The possible values are either `ACTIVE` or `EXPIRED`. The `ACTIVE` link can be send to end users to collect diagnostic data. The `EXPIRED` link is older than 7 days or has reached the limit of 50 submission. You can't collect more data with the `EXPIRED` link.", "type": "string", "enum": [ "ACTIVE", "EXPIRED" ] }, "expiryTime": { "description": "ISO 8601 timestamp indicating when `diagnosticLink` expires.", "format": "date-time", "type": "string" }, "groupId": { "description": "Unique identifier for the group.", "minLength": 1, "type": "string" }, "ipaHostname": { "description": "IP acceleration hostname you collect the diagnostic data for. Depending on the group settings, either this value or `url` occurs.", "format": "hostname", "type": "string" }, "note": { "description": "Notes about the group or issues experienced by group's end users.", "minLength": 1, "type": "string" }, "records": { "description": "Lists diagnostics data collected from the group's end users.", "minItems": 0, "type": "array", "items": { "additionalProperties": false, "type": "object", "required": [ "cipher", "cookie", "protocol", "userAgent", "createdTime", "createdEpoch", "uniqueId" ], "properties": { "cipher": { "description": "Cryptographic algorithm used between the client and `www.t1info.net`.", "minLength": 1, "type": "string" }, "clientDnsIpv4": { "additionalProperties": false, "description": "Specifies the IP address of the DNS server which the client uses to connect to the edge IPv4 address.", "type": "object", "required": [ "id", "ip", "ipType", "ipLocation", "ecs" ], "properties": { "ecs": { "description": "Client subnet information provided by the recursive DNS service.", "minLength": 1, "type": "string" }, "id": { "description": "Unique identifier for the IPv4 DNS server.", "minimum": 0, "type": "integer" }, "ip": { "description": "DNS IPv4 value.", "minLength": 1, "type": "string" }, "ipLocation": { "additionalProperties": false, "description": "Collects data about the location of the DNS IPv4 server.", "type": "object", "required": [ "city", "regionCode", "countryCode", "asNumber" ], "properties": { "asNumber": { "description": "Autonomous System Number the edge IP maps to.", "minimum": 0, "type": "integer" }, "city": { "description": "Closest city within a 50-mile radius the edge IP maps to.", "minLength": 1, "type": "string" }, "countryCode": { "description": "ISO 3166 country code the edge IP maps to.", "minLength": 1, "type": "string" }, "regionCode": { "description": "ISO 3166 region code the edge IP maps to.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/edgeIpLocation.yaml" } }, "ipType": { "description": "Type of the IP.", "minLength": 1, "type": "string" } } }, "clientDnsIpv6": { "additionalProperties": false, "description": "Specifies the IP address of the DNS server which the client uses to connect to the edge IPv6 address.", "type": "object", "required": [ "id", "ip", "ipType", "ipLocation", "ecs" ], "properties": { "ecs": { "description": "Client subnet information provided by the recursive DNS service.", "minLength": 1, "type": "string" }, "id": { "description": "Unique identifier for the IPv6 DNS server.", "minimum": 0, "type": "integer" }, "ip": { "description": "DNS IPv6 value.", "minLength": 1, "type": "string" }, "ipLocation": { "additionalProperties": false, "description": "Collects data about the location of the DNS IPv6 server.", "type": "object", "required": [ "city", "regionCode", "countryCode", "asNumber" ], "properties": { "asNumber": { "description": "Autonomous System Number the edge IP maps to.", "minimum": 0, "type": "integer" }, "city": { "description": "Closest city within a 50-mile radius the edge IP maps to.", "minLength": 1, "type": "string" }, "countryCode": { "description": "ISO 3166 country code the edge IP maps to.", "minLength": 1, "type": "string" }, "regionCode": { "description": "ISO 3166 region code the edge IP maps to.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/edgeIpLocation.yaml" } }, "ipType": { "description": "Type of the IP.", "minLength": 1, "type": "string" } } }, "clientIpv4": { "additionalProperties": false, "description": "Specifies the client IPv4 address used to connect to the edge server.", "type": "object", "required": [ "id", "ip", "ipType", "associatedDnsId", "ipLocation" ], "properties": { "associatedDnsId": { "description": "DNS IP assigned to the client IP.", "minimum": 0, "type": "integer" }, "id": { "description": "Unique identifier for the client IP.", "minimum": 0, "type": "integer" }, "ip": { "description": "Client IPv4 value.", "minLength": 1, "type": "string" }, "ipLocation": { "additionalProperties": false, "description": "Collects data about the location of the client IPv4 address.", "type": "object", "required": [ "city", "regionCode", "countryCode", "asNumber" ], "properties": { "asNumber": { "description": "Autonomous System Number the edge IP maps to.", "minimum": 0, "type": "integer" }, "city": { "description": "Closest city within a 50-mile radius the edge IP maps to.", "minLength": 1, "type": "string" }, "countryCode": { "description": "ISO 3166 country code the edge IP maps to.", "minLength": 1, "type": "string" }, "regionCode": { "description": "ISO 3166 region code the edge IP maps to.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/edgeIpLocation.yaml" } }, "ipType": { "description": "Type of the IP.", "minLength": 1, "type": "string" } } }, "clientIpv6": { "additionalProperties": false, "description": "Specifies the client IPv6 address used to connect to the edge server.", "type": "object", "required": [ "id", "ip", "ipType", "associatedDnsId", "ipLocation" ], "properties": { "associatedDnsId": { "description": "DNS IP assigned to the client IP.", "minimum": 0, "type": "integer" }, "id": { "description": "Unique identifier for the client IP.", "minimum": 0, "type": "integer" }, "ip": { "description": "Client IPv6 value.", "minLength": 1, "type": "string" }, "ipLocation": { "additionalProperties": false, "description": "Collects data about the location of the client IPv6 address.", "type": "object", "required": [ "city", "regionCode", "countryCode", "asNumber" ], "properties": { "asNumber": { "description": "Autonomous System Number the edge IP maps to.", "minimum": 0, "type": "integer" }, "city": { "description": "Closest city within a 50-mile radius the edge IP maps to.", "minLength": 1, "type": "string" }, "countryCode": { "description": "ISO 3166 country code the edge IP maps to.", "minLength": 1, "type": "string" }, "regionCode": { "description": "ISO 3166 region code the edge IP maps to.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/edgeIpLocation.yaml" } }, "ipType": { "description": "Type of the IP.", "minLength": 1, "type": "string" } } }, "cookie": { "description": "Stores cookie values for the `www.t1info.net` website on the client's machine.", "type": "boolean" }, "createdEpoch": { "description": "When the data was collected, in epoch seconds.", "minimum": 0, "type": "integer" }, "createdTime": { "description": "ISO 8601 timestamp indicating when the diagnostic data was collected.", "format": "date-time", "type": "string" }, "curlResults": { "description": "Collects cURL data and details about the request. It shows only for the `includeCurl` query parameter of the request set to `true` and fetched `edgeIps` details.", "minItems": 0, "type": "array", "items": { "additionalProperties": false, "type": "object", "required": [ "request", "executionStatus", "createdBy", "createdTime", "internalIp", "regionId", "result" ], "properties": { "createdBy": { "description": "Username who has submitted the cURL request.", "minLength": 1, "type": "string" }, "createdTime": { "description": "ISO 8601 timestamp indicating when the cURL request was submitted.", "format": "date-time", "type": "string" }, "executionStatus": { "description": "The cURL request status. Possible values are `SUCCESS`, `IN_PROGRESS`, or `FAILURE`.", "type": "string", "enum": [ "SUCCESS", "IN_PROGRESS", "FAILURE" ] }, "internalIp": { "description": "Real machine IP behind `edgeIds`.", "minLength": 1, "type": "string" }, "regionId": { "description": "Unique identifiers for `edgeIds` regions.", "minimum": 1, "type": "integer" }, "request": { "additionalProperties": false, "description": "Collects request data for cURL.", "type": "object", "required": [ "requestHeaders", "ipVersion", "url", "edgeIds" ], "properties": { "edgeIds": { "description": "Unique identifiers for edge IPs for the cURL request.", "minItems": 0, "type": "array", "items": { "minimum": 0, "type": "integer" } }, "ipVersion": { "description": "IP version used to run the operation, either `IPV4` or `IPV6`.", "type": "string", "enum": [ "IPV4", "IPV6" ] }, "requestHeaders": { "description": "Customized headers for `curl` request in the format `header: value`.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } }, "url": { "description": "URL for the cURL request.", "format": "uri", "type": "string" } } }, "result": { "additionalProperties": false, "description": "Collects the cURL response.", "minProperties": 1, "type": "object", "required": [ "exitCode" ], "properties": { "exitCode": { "description": "Curl command exit code. [List of possible curl exit code.](https://curl.se/libcurl/c/libcurl-errors.html) ", "minimum": 0, "type": "integer" }, "httpStatusCode": { "description": "Returned HTTP response code.", "maximum": 599, "minimum": 100, "type": "integer" }, "httpVersion": { "description": "HTTP version used for `curl`.", "minLength": 1, "type": "string" }, "reasonPhrase": { "description": "Reason phrase for the response.", "minLength": 1, "type": "string" }, "responseBody": { "description": "Entire response body.", "minLength": 1, "type": "string" }, "responseHeaderList": { "description": "Collects the response headers in the format `header: value`.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } }, "timing": { "additionalProperties": false, "description": "Collects the time related data.", "type": "object", "required": [ "dnsLookupTime", "tcpConnectionTime", "sslConnectionTime", "timeToFirstByte", "totalTime" ], "properties": { "dnsLookupTime": { "description": "DNS lookup time, in seconds.", "minimum": 0, "type": "number" }, "sslConnectionTime": { "description": "SSL connection time, in seconds.", "minimum": 0, "type": "number" }, "tcpConnectionTime": { "description": "TCP connection time, in seconds.", "minimum": 0, "type": "number" }, "timeToFirstByte": { "description": "Time to first byte, in seconds.", "minimum": 0, "type": "number" }, "totalTime": { "description": "Total time, in seconds.", "minimum": 0, "type": "number" } } } }, "x-akamai": { "file-path": "schemas/curlResults.yaml" } } } } }, "digResults": { "description": "Lists the DIG response and details about the request. It shows only for the `includeDig` query parameter of the request set to `true` and fetched `edgeIps` details.", "minItems": 0, "type": "array", "items": { "additionalProperties": false, "type": "object", "required": [ "request", "executionStatus", "createdBy", "createdTime", "internalIp", "regionId", "result" ], "properties": { "createdBy": { "description": "Username who submitted the DIG request.", "minLength": 1, "type": "string" }, "createdTime": { "description": "ISO 8601 timestamp indicating when the DIG request was submitted.", "format": "date-time", "type": "string" }, "executionStatus": { "description": "Dig request status. Possible values are `SUCCESS`, `IN_PROGRESS`, or `FAILURE`.", "type": "string", "enum": [ "SUCCESS", "IN_PROGRESS", "FAILURE" ] }, "internalIp": { "description": "Real machine IP behind `edgeIds`.", "minLength": 1, "type": "string" }, "regionId": { "description": "Unique identifiers for `edgeIds` regions.", "minimum": 1, "type": "integer" }, "request": { "additionalProperties": false, "description": "Collects request data for dig.", "type": "object", "required": [ "hostname", "queryType", "edgeIds" ], "properties": { "edgeIds": { "description": "Unique identifiers for edge IPs for the DIG request.", "minItems": 0, "type": "array", "items": { "minimum": 0, "type": "integer" } }, "hostname": { "description": "Hostname or a domain name you want to get the data for.", "format": "hostname", "type": "string" }, "queryType": { "description": "DNS record type you want to get. Possible values are: `A`, `AAAA`, `SOA`, `CNAME`, `PTR`, `MX`, `NS`, `TXT`, `SRV`, `CAA`, and `ANY`. To learn more about them, check [Supported DNS record types](https://techdocs.akamai.com/edge-diagnostics/docs/domain-details-dig#supported-dns-record-types).", "type": "string", "enum": [ "A", "SOA", "CNAME", "PTR", "MX", "AAAA", "NS", "TXT", "SRV", "CAA", "ANY" ] } } }, "result": { "additionalProperties": false, "description": "Collects DIG results.", "type": "object", "required": [ "result" ], "properties": { "answerSection": { "description": "Collects a DNS record of answering servers.", "minItems": 1, "type": "array", "items": { "additionalProperties": false, "description": "Specifies a DNS record that appears within a response of the [Get domain details with dig](https://techdocs.akamai.com/edge-diagnostics/reference/post-dig) operation, in `answerSection` or `authoritySection`.", "type": "object", "properties": { "domain": { "description": "Domain name for this record.", "minLength": 1, "type": "string" }, "hostname": { "description": "Hostname you requested the data for.", "format": "hostname", "type": "string" }, "preferenceValue": { "description": "Preference value, only valid for records of the `MX` type, otherwise `null`.", "minimum": 0, "nullable": true, "type": "integer" }, "recordClass": { "description": "Class of the record, typically `IN` for *internet*.", "minLength": 1, "type": "string" }, "recordType": { "description": "Requested record type. Possible values are: `A`, `AAAA`, `SOA`, `CNAME`, `PTR`, `MX`, `NS`, `TXT`, `SRV`, `CAA`, and `ANY`. To learn more about them, check [Supported DNS record types](https://techdocs.akamai.com/edge-diagnostics/docs/domain-details-dig#supported-dns-record-types).", "type": "string", "enum": [ "A", "AAAA", "SOA", "CNAME", "PTR", "MX", "NS", "TXT", "SRV", "CAA", "ANY" ] }, "ttl": { "description": "Server's default number of seconds to keep content cached.", "minimum": 0, "type": "integer" }, "value": { "description": "Record's value, either another domain or a final IP address.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/dnsRecord.yaml" }, "oneOf": [ { "title": "Hostname required", "required": [ "hostname", "ttl", "recordClass", "recordType", "value" ] }, { "title": "Domain required", "required": [ "domain", "ttl", "recordClass", "recordType", "value" ] } ] } }, "authoritySection": { "description": "Collects a DNS record of servers authorized to answer.", "minItems": 1, "type": "array", "items": { "additionalProperties": false, "description": "Specifies a DNS record that appears within a response of the [Get domain details with dig](https://techdocs.akamai.com/edge-diagnostics/reference/post-dig) operation, in `answerSection` or `authoritySection`.", "type": "object", "properties": { "domain": { "description": "Domain name for this record.", "minLength": 1, "type": "string" }, "hostname": { "description": "Hostname you requested the data for.", "format": "hostname", "type": "string" }, "preferenceValue": { "description": "Preference value, only valid for records of the `MX` type, otherwise `null`.", "minimum": 0, "nullable": true, "type": "integer" }, "recordClass": { "description": "Class of the record, typically `IN` for *internet*.", "minLength": 1, "type": "string" }, "recordType": { "description": "Requested record type. Possible values are: `A`, `AAAA`, `SOA`, `CNAME`, `PTR`, `MX`, `NS`, `TXT`, `SRV`, `CAA`, and `ANY`. To learn more about them, check [Supported DNS record types](https://techdocs.akamai.com/edge-diagnostics/docs/domain-details-dig#supported-dns-record-types).", "type": "string", "enum": [ "A", "AAAA", "SOA", "CNAME", "PTR", "MX", "NS", "TXT", "SRV", "CAA", "ANY" ] }, "ttl": { "description": "Server's default number of seconds to keep content cached.", "minimum": 0, "type": "integer" }, "value": { "description": "Record's value, either another domain or a final IP address.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/dnsRecord.yaml" }, "oneOf": [ { "title": "Hostname required", "required": [ "hostname", "ttl", "recordClass", "recordType", "value" ] }, { "title": "Domain required", "required": [ "domain", "ttl", "recordClass", "recordType", "value" ] } ] } }, "result": { "description": "Raw `dig` output.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/digInfo.yaml" } } } } }, "edgeIps": { "description": "Lists data about edge servers hosting `url` or `ipaHostname`. If it doesn't occur, it's either because of a system error or the client DNS has an EDNS Client Subnet (ECS).", "minItems": 0, "type": "array", "items": { "additionalProperties": false, "type": "object", "required": [ "id", "ip", "ipType", "associatedDnsId", "ipLocation", "regionId" ], "properties": { "associatedDnsId": { "description": "DNS IP assigned to the edge server.", "minimum": 0, "type": "integer" }, "id": { "description": "Unique identifier for the edge server.", "minimum": 0, "type": "integer" }, "ip": { "description": "Edge server IP.", "minLength": 1, "type": "string" }, "ipLocation": { "additionalProperties": false, "description": "Collects data about the location of edge servers hosting the URL.", "type": "object", "required": [ "city", "regionCode", "countryCode", "asNumber" ], "properties": { "asNumber": { "description": "Autonomous System Number the edge IP maps to.", "minimum": 0, "type": "integer" }, "city": { "description": "Closest city within a 50-mile radius the edge IP maps to.", "minLength": 1, "type": "string" }, "countryCode": { "description": "ISO 3166 country code the edge IP maps to.", "minLength": 1, "type": "string" }, "regionCode": { "description": "ISO 3166 region code the edge IP maps to.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/edgeIpLocation.yaml" } }, "ipType": { "description": "Type of the IP.", "minLength": 1, "type": "string" }, "regionId": { "description": "Unique identifier for the edge server region.", "minimum": 1, "type": "integer" } } } }, "mtrResults": { "description": "Lists MTR results and details about the request. It shows only for the `includeMtr` query parameter of the request set to `true` and fetched `edgeIps` details.", "minItems": 0, "type": "array", "items": { "additionalProperties": false, "type": "object", "required": [ "request", "executionStatus", "createdBy", "createdTime", "sourceInternalIp", "regionId", "result" ], "properties": { "createdBy": { "description": "Username who submitted the MTR request.", "minLength": 1, "type": "string" }, "createdTime": { "description": "ISO 8601 timestamp indicating when the MTR request was submitted.", "format": "date-time", "type": "string" }, "executionStatus": { "description": "MTR request status. Possible values are `SUCCESS`, `IN_PROGRESS`, or `FAILURE`.", "type": "string", "enum": [ "SUCCESS", "IN_PROGRESS", "FAILURE" ] }, "regionId": { "description": "Unique identifiers for `sourceIds` regions.", "minimum": 1, "type": "integer" }, "request": { "additionalProperties": false, "description": "Collects request data for MTR.", "type": "object", "required": [ "ipVersion", "port", "packetType", "sourceIds", "destinationId" ], "properties": { "destinationId": { "description": "Unique identifier for the IP address being the destination of the MTR.", "minimum": 0, "type": "integer" }, "ipVersion": { "description": "IP version used by MTR. Possible values are either `IPV4` or `IPV6`.", "type": "string", "enum": [ "IPV4", "IPV6" ] }, "packetType": { "description": "Packet type used by MTR. Possible values are either `TCP` or `ICMP`.", "type": "string", "enum": [ "TCP", "ICMP" ] }, "port": { "description": "Port number used by MTR, either `80` or `443`.", "type": "integer", "enum": [ 80, 443 ] }, "sourceIds": { "description": "Unique identifier for the IP address being the source of the MTR.", "minItems": 0, "type": "array", "items": { "minimum": 0, "type": "integer" } } } }, "result": { "additionalProperties": false, "description": "Standard MTR results.", "type": "object", "required": [ "startTime", "host", "packetLoss", "averageLatency", "hops", "result" ], "properties": { "averageLatency": { "description": "Average latency for all hops, in seconds.", "minimum": 0, "type": "number" }, "hops": { "description": "Lists network hops with their data.", "minItems": 0, "type": "array", "items": { "additionalProperties": false, "description": "Collects network hops with their data.", "type": "object", "required": [ "number", "host", "ip", "ipLocation", "packetLoss", "sentPackets", "lastPacketLatency", "averageLatency", "bestRtt", "worstRtt", "standardDeviation" ], "properties": { "averageLatency": { "description": "Average hop value, useful to detect ongoing problems.", "minimum": 0, "type": "number" }, "bestRtt": { "description": "Fastest time, in milliseconds.", "minimum": 0, "type": "number" }, "host": { "description": "Host or domain name for the hop.", "minLength": 1, "type": "string" }, "ip": { "description": "IP of the hop's `edgeHost`.", "minLength": 1, "type": "string" }, "ipLocation": { "additionalProperties": false, "description": "Geolocation data for the hop's `edgeHost`.", "type": "object", "required": [ "city", "regionCode", "countryCode", "asNumber" ], "properties": { "asNumber": { "description": "Autonomous System Number the edge IP maps to.", "minimum": 0, "type": "integer" }, "city": { "description": "Closest city within a 50-mile radius the edge IP maps to.", "minLength": 1, "type": "string" }, "countryCode": { "description": "ISO 3166 country code the edge IP maps to.", "minLength": 1, "type": "string" }, "regionCode": { "description": "ISO 3166 region code the edge IP maps to.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/edgeIpLocation.yaml" } }, "lastPacketLatency": { "description": "Last measured hop value, useful to detect ongoing problems.", "minimum": 0, "type": "number" }, "number": { "description": "Index for each hop's count within the full set.", "minimum": 0, "type": "integer" }, "packetLoss": { "description": "Percentage of packets lost for the hop, maximum `100`.", "maximum": 100, "minimum": 0, "type": "number" }, "sentPackets": { "description": "Number of packets sent for the hop.", "minimum": 0, "type": "integer" }, "standardDeviation": { "description": "Standard deviation, in milliseconds.", "minimum": 0, "type": "number" }, "worstRtt": { "description": "Slowest time, in milliseconds.", "minimum": 0, "type": "number" } }, "x-akamai": { "file-path": "schemas/mtrHopInstance.yaml" } } }, "host": { "description": "Hostname within the edge network that corresponds to the `source` IP address.", "format": "hostname", "type": "string" }, "packetLoss": { "description": "Percentage of packets lost, maximum `100`.", "maximum": 100, "minimum": 0, "type": "number" }, "result": { "description": "Raw MTR utility output.", "minLength": 1, "type": "string" }, "startTime": { "description": "Epoch timestamp marking when MTR was run.", "type": "integer" } }, "x-akamai": { "file-path": "schemas/mtrData.yaml" } }, "sourceInternalIp": { "description": "Real machine IP behind `sourceIds`.", "minimum": 0, "type": "integer" } } } }, "preferredClientIp": { "additionalProperties": false, "description": "Specifies IP address preferred by the end user to connect to the server.", "type": "object", "required": [ "id", "ip", "ipType", "associatedDnsId", "ipLocation" ], "properties": { "associatedDnsId": { "description": "DNS IP assigned to the server.", "minimum": 0, "type": "integer" }, "id": { "description": "Unique identifier for the server of the preferred IP.", "minimum": 0, "type": "integer" }, "ip": { "description": "IP address preferred by the end user.", "minLength": 1, "type": "string" }, "ipLocation": { "additionalProperties": false, "description": "Specifies the server location. ", "type": "object", "required": [ "city", "regionCode", "countryCode", "asNumber" ], "properties": { "asNumber": { "description": "Autonomous System Number the edge IP maps to.", "minimum": 0, "type": "integer" }, "city": { "description": "Closest city within a 50-mile radius the edge IP maps to.", "minLength": 1, "type": "string" }, "countryCode": { "description": "ISO 3166 country code the edge IP maps to.", "minLength": 1, "type": "string" }, "regionCode": { "description": "ISO 3166 region code the edge IP maps to.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/edgeIpLocation.yaml" } }, "ipType": { "description": "Type of the IP.", "minLength": 1, "type": "string" } } }, "protocol": { "description": "HTTP protocol used to connect the client and `www.t1info.net`.", "minLength": 1, "type": "string" }, "uniqueId": { "description": "Unique identifier for the collected data. You can share it with the technical support to identify the submitted data.", "minimum": 0, "type": "integer" }, "userAgent": { "description": "Application, operating system, vendor, and optionally the version of the requesting user agent.", "minLength": 1, "type": "string" } } } }, "submissionsRemaining": { "description": "Number of submissions remaining with `diagnosticLink`. Each link can collect up to 50 submissions.", "minimum": 0, "type": "integer" }, "url": { "description": "URL you collect the diagnostic data for. Depending on the group settings, either this value or `ipaHostname` occurs.", "format": "uri", "type": "string" } }, "x-akamai": { "file-path": "schemas/userDiagnosticDataRecordGetResponse.yaml" }, "oneOf": [ { "title": "URL request", "required": [ "url", "groupId", "createdTime", "expiryTime", "diagnosticLink", "diagnosticLinkStatus", "createdBy", "submissionsRemaining" ] }, { "title": "IPA hostname request", "required": [ "ipaHostname", "groupId", "createdTime", "expiryTime", "diagnosticLink", "diagnosticLinkStatus", "createdBy", "submissionsRemaining" ] } ] } } }, "headers": { "X-RateLimit-Limit": { "description": "The rate limit ceiling for this endpoint.", "example": 10, "schema": { "type": "integer" }, "x-akamai": { "file-path": "headers/X-RateLimit-Limit.yaml" } }, "X-RateLimit-Remaining": { "description": "The number of requests left for the time window.", "example": 5, "schema": { "type": "integer" }, "x-akamai": { "file-path": "headers/X-RateLimit-Remaining.yaml" } } } }, "401": { "description": "[Authorization error](https://techdocs.akamai.com/edge-diagnostics/reference/401).", "content": { "application/problem+json": { "example": { "detail": "Inactive client token", "instance": "https://akab-nedrvuylepskzabx-lv3dgceqqktx3i5b.luna.akamaiapis.net/edge-diagnostics/v1/grep/requests", "status": 401, "title": "Not authorized", "type": "https://problems.luna.akamaiapis.net/-/pep-authn/deny" }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/401.yaml" } }, "403": { "description": "[Permission error](https://techdocs.akamai.com/edge-diagnostics/reference/403).", "content": { "application/problem+json": { "example": { "status": 403, "title": "Forbidden request.", "type": "forbidden.request.error", "errors": [ { "detail": "You don't have access to the requested URL. Contact your Admin to request access.", "requestField": "url", "title": "Field access denied.", "type": "field.access.denied" } ] }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/403.yaml" } }, "404": { "description": "[Resource not found error](https://techdocs.akamai.com/edge-diagnostics/reference/404).", "content": { "application/problem+json": { "example": { "detail": "The requested resource couldn't be found. Make sure that the resource is not deleted and the ID is correct.", "status": 404, "title": "Resource not found.", "type": "resource.not.found" }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/404.yaml" } }, "405": { "description": "[Method not allowed](https://techdocs.akamai.com/edge-diagnostics/reference/405).", "content": { "application/problem+json": { "example": { "title": "Method not allowed", "type": "method.not.allowed" }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/405.yaml" } }, "429": { "description": "[Too many requests](https://techdocs.akamai.com/edge-diagnostics/reference/429).", "content": { "application/problem+json": { "example": { "detail": "You have exceeded total number of requests configured for this API.", "status": 429, "title": "Too Many Requests", "type": "requests.exceeded.error" }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/429.yaml" } } }, "parameters": [ { "description": "Includes `curl` results in the response.", "example": "{{includeCurl}}", "in": "query", "name": "includeCurl", "schema": { "example": true, "type": "boolean" }, "x-akamai": { "file-path": "parameters/includeCurl.yaml" } }, { "description": "Includes `dig` results in the response.", "example": "{{includeDig}}", "in": "query", "name": "includeDig", "schema": { "example": true, "type": "boolean" }, "x-akamai": { "file-path": "parameters/includeDig.yaml" } }, { "description": "Includes MTR results in the response.", "example": "{{includeMtr}}", "in": "query", "name": "includeMtr", "schema": { "example": true, "type": "boolean" }, "x-akamai": { "file-path": "parameters/includeMtr.yaml" } }, { "description": "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ] }, "parameters": [ { "description": "Unique identifier for a group. To get this value, run the [List groups](https://techdocs.akamai.com/edge-diagnostics/reference/get-user-diagnostic-data-groups) operation.", "example": "{{groupId}}", "in": "path", "name": "groupId", "required": true, "schema": { "example": "623b8c", "type": "string" }, "x-akamai": { "file-path": "parameters/groupId-path.yaml" } } ] }, "/verify-edge-ip": { "post": { "description": "Verifies if an IP belongs to an edge server. For IPs verified positively, you can continue gathering diagnostic data with [Request content with cURL](https://techdocs.akamai.com/edge-diagnostics/reference/post-curl), [Get domain details with dig](https://techdocs.akamai.com/edge-diagnostics/reference/post-dig), or [Test network connectivity with MTR](https://techdocs.akamai.com/edge-diagnostics/reference/post-mtr) operations. You can enter up to 10 IPs.", "operationId": "post-verify-edge-ip", "summary": "Verify an IP", "tags": [ "IP verification and location" ], "externalDocs": { "description": "See documentation for this operation in Akamai's Edge Diagnostics API", "url": "https://techdocs.akamai.com/edge-diagnostics/reference/post-verify-edge-ip" }, "requestBody": { "required": true, "content": { "application/json": { "example": { "ipAddresses": [ "192.0.2.9", "192.0.2.0" ] }, "schema": { "additionalProperties": false, "description": "Specifies IP addresses you want to [verify](https://techdocs.akamai.com/edge-diagnostics/reference/post-verify-edge-ip) or get the [location data](https://techdocs.akamai.com/edge-diagnostics/reference/post-locate-ip) for.", "type": "object", "required": [ "ipAddresses" ], "properties": { "ipAddresses": { "description": "Up to 10 IP addresses you want to get the data for.", "maxItems": 10, "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } } }, "x-akamai": { "file-path": "schemas/verifyLocateIpsRequest.yaml" } } } } }, "responses": { "200": { "description": "The response provides the verification results and details about the request.", "content": { "application/json": { "example": { "completedTime": "2022-02-01T17:40:32Z", "createdBy": "tyamada", "createdTime": "2022-02-01T17:40:29Z", "executionStatus": "SUCCESS", "request": { "ipAddresses": [ "192.0.2.9", "192.0.2.0" ] }, "results": [ { "executionStatus": "SUCCESS", "ipAddress": "192.0.2.9", "isEdgeIp": false }, { "executionStatus": "SUCCESS", "ipAddress": "192.0.2.0", "isEdgeIp": false } ] }, "schema": { "additionalProperties": false, "description": "Collects information whether an IP belongs to an edge server and details about the request.", "type": "object", "required": [ "request", "createdBy", "createdTime", "executionStatus", "results" ], "properties": { "completedTime": { "description": "ISO 8601 timestamp indicating when the request was completed.", "format": "date-time", "type": "string" }, "createdBy": { "description": "Username who submitted the request.", "minLength": 1, "type": "string" }, "createdTime": { "description": "ISO 8601 timestamp indicating when the request was submitted.", "format": "date-time", "type": "string" }, "executionStatus": { "description": "Status of the request's execution. Possible values are: `SUCCESS`, `FAILURE`, or `PARTIAL_SUCCESS`. `PARTIAL_SUCCESS` is for bulk requests, if some of the requested IPs couldn't be processed.", "type": "string", "enum": [ "SUCCESS", "FAILURE", "PARTIAL_SUCCESS" ] }, "request": { "additionalProperties": false, "description": "IP addresses you want to get the data for.", "type": "object", "required": [ "ipAddresses" ], "properties": { "ipAddresses": { "description": "Up to 10 IP addresses you want to get the data for.", "maxItems": 10, "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } } }, "x-akamai": { "file-path": "schemas/verifyLocateIpsRequest.yaml" } }, "results": { "description": "Lists results for requested IPs.", "minItems": 0, "type": "array", "items": { "additionalProperties": false, "type": "object", "required": [ "executionStatus", "ipAddress", "isEdgeIp" ], "properties": { "executionStatus": { "description": "Status of the execution, either `SUCCESS` or `FAILURE`.", "type": "string", "enum": [ "SUCCESS", "FAILURE" ] }, "ipAddress": { "description": "IP address of the request.", "minLength": 1, "type": "string" }, "isEdgeIp": { "description": "Results of the verification.", "type": "boolean" } }, "x-akamai": { "file-path": "schemas/verifyEdgeIpData.yaml" } } } }, "x-akamai": { "file-path": "schemas/verifyEdgeIp.yaml" } } } }, "headers": { "X-RateLimit-Limit": { "description": "The rate limit ceiling for this endpoint.", "example": 10, "schema": { "type": "integer" }, "x-akamai": { "file-path": "headers/X-RateLimit-Limit.yaml" } }, "X-RateLimit-Remaining": { "description": "The number of requests left for the time window.", "example": 5, "schema": { "type": "integer" }, "x-akamai": { "file-path": "headers/X-RateLimit-Remaining.yaml" } } } }, "400": { "description": "[Validation error](https://techdocs.akamai.com/edge-diagnostics/reference/400).", "content": { "application/problem+json": { "example": { "detail": "Provide only one of these members, either `edgeLocationId` or `edgeIp`.", "status": 400, "title": "Incorrect request.", "type": "bad.request.error", "errors": [ { "requestField": "edgeLocationId", "title": "Conflicting values.", "type": "field.conflict" }, { "requestField": "edgeIp", "title": "Conflicting values.", "type": "field.conflict" } ] }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/400.yaml" } }, "401": { "description": "[Authorization error](https://techdocs.akamai.com/edge-diagnostics/reference/401).", "content": { "application/problem+json": { "example": { "detail": "Inactive client token", "instance": "https://akab-nedrvuylepskzabx-lv3dgceqqktx3i5b.luna.akamaiapis.net/edge-diagnostics/v1/grep/requests", "status": 401, "title": "Not authorized", "type": "https://problems.luna.akamaiapis.net/-/pep-authn/deny" }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/401.yaml" } }, "403": { "description": "[Permission error](https://techdocs.akamai.com/edge-diagnostics/reference/403).", "content": { "application/problem+json": { "example": { "status": 403, "title": "Forbidden request.", "type": "forbidden.request.error", "errors": [ { "detail": "You don't have access to the requested URL. Contact your Admin to request access.", "requestField": "url", "title": "Field access denied.", "type": "field.access.denied" } ] }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/403.yaml" } }, "405": { "description": "[Method not allowed](https://techdocs.akamai.com/edge-diagnostics/reference/405).", "content": { "application/problem+json": { "example": { "title": "Method not allowed", "type": "method.not.allowed" }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/405.yaml" } }, "429": { "description": "[Too many requests](https://techdocs.akamai.com/edge-diagnostics/reference/429).", "content": { "application/problem+json": { "example": { "detail": "You have exceeded total number of requests configured for this API.", "status": 429, "title": "Too Many Requests", "type": "requests.exceeded.error" }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/429.yaml" } } }, "parameters": [ { "description": "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ] } }, "/verify-locate-ip": { "post": { "description": "Verifies if an IP belongs to an edge server and gets the geolocation data of its network. For IPs verified positively, you can continue gathering diagnostic data with [Request content with cURL](https://techdocs.akamai.com/edge-diagnostics/reference/post-curl), [Get domain details with dig](https://techdocs.akamai.com/edge-diagnostics/reference/post-dig), or [Test network connectivity with MTR](https://techdocs.akamai.com/edge-diagnostics/reference/post-mtr) operations.", "operationId": "post-verify-locate-ip", "summary": "Verify and locate an IP", "tags": [ "IP verification and location" ], "externalDocs": { "description": "See documentation for this operation in Akamai's Edge Diagnostics API", "url": "https://techdocs.akamai.com/edge-diagnostics/reference/post-verify-locate-ip" }, "requestBody": { "required": true, "content": { "application/json": { "example": { "ipAddress": "192.0.2.12" }, "schema": { "additionalProperties": false, "description": "Specifies the IP address you want to [verify](https://techdocs.akamai.com/edge-diagnostics/reference/post-verify-edge-ip) or get the [location data](https://techdocs.akamai.com/edge-diagnostics/reference/post-locate-ip) for, or [both](https://techdocs.akamai.com/edge-diagnostics/reference/post-verify-locate-ip).", "type": "object", "required": [ "ipAddress" ], "properties": { "ipAddress": { "description": "IP address you want to get the data for.", "example": "{{ipAddress}}", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/verifyLocateIpRequest.yaml" } } } } }, "responses": { "200": { "description": "The response provides the verification results, network location data, and details about the request.", "content": { "application/json": { "example": { "createdBy": "alfulani", "createdTime": "2021-10-04T15:01:46Z", "executionStatus": "SUCCESS", "request": { "ipAddress": "192.0.2.12" }, "result": { "isEdgeIp": false, "geoLocation": { "asNumber": 4808, "city": "BEIJING", "continent": "AS", "countryCode": "CN", "latitude": 39.9, "longitude": 116.41, "network": "chinaunicom", "regionCode": "BJ", "throughput": "vhigh", "timeZone": "GMT+8" } } }, "schema": { "additionalProperties": false, "description": "Specifies the IP's network location, verification results, and details about the request.", "type": "object", "required": [ "request", "createdBy", "createdTime", "executionStatus", "result" ], "properties": { "createdBy": { "description": "Username who submitted the request.", "minLength": 1, "type": "string" }, "createdTime": { "description": "ISO 8601 timestamp indicating when the request was submitted.", "format": "date-time", "type": "string" }, "executionStatus": { "description": "Status of the request's execution, either `SUCCESS` or `FAILURE`.", "type": "string", "enum": [ "SUCCESS", "FAILURE" ] }, "request": { "additionalProperties": false, "description": "IP address you want to get the data for.", "type": "object", "required": [ "ipAddress" ], "properties": { "ipAddress": { "description": "IP address you want to get the data for.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/verifyLocateIpRequest.yaml" } }, "result": { "additionalProperties": false, "description": "Specifies the IP's network location and verification results.", "type": "object", "required": [ "isEdgeIp", "geoLocation" ], "properties": { "geoLocation": { "additionalProperties": false, "description": "Specifies the IP's network location. To learn more about the results, check [Verify and Locate IP results](https://techdocs.akamai.com/edge-diagnostics/docs/verify-locate-ip#results).", "type": "object", "properties": { "areaCode": { "description": "List of comma-delimited area codes the IP's network maps to.", "minLength": 1, "type": "string" }, "asNumber": { "description": "Autonomous System Number the IP's network maps to.", "minimum": 0, "type": "integer" }, "city": { "description": "Closest city within a 50-mile radius the IP's network maps to.", "minLength": 1, "type": "string" }, "continent": { "description": "ISO 3166 continent code the IP's network maps to.", "minLength": 1, "type": "string" }, "countryCode": { "description": "ISO 3166 country code the IP's network maps to.", "minLength": 1, "type": "string" }, "county": { "description": "Counties the IP's network maps to. Multiple values are separated with `+`.", "minLength": 0, "type": "string" }, "dma": { "description": "Designated Market Area code the IP's network maps to.", "minimum": 0, "type": "integer" }, "fips": { "description": "Federal Information Processing Standards code the IP's network maps to.", "minLength": 1, "type": "string" }, "latitude": { "description": "The latitude the IP's network maps to.", "maximum": 90, "minimum": -90, "type": "number" }, "longitude": { "description": "The longitude the IP's network maps to.", "maximum": 180, "minimum": -180, "type": "number" }, "msa": { "description": "Metropolitan Statistical Area code the IP's network maps to.", "minimum": 0, "type": "integer" }, "network": { "description": "Network the IP maps to. The value may be `null` when edge servers lack that data.", "minLength": 1, "nullable": true, "type": "string" }, "networkType": { "description": "Network type the IP maps to. The value may be `null` when edge servers lack that data.", "minLength": 1, "nullable": true, "type": "string" }, "pmsa": { "description": "Primary Metropolitan Statistical Area code the IP's network maps to.", "minimum": 0, "type": "integer" }, "proxy": { "description": "Proxy the IP maps to. The value may be `null` when the IP address is not a proxy.", "minLength": 1, "nullable": true, "type": "string" }, "regionCode": { "description": "ISO 3166 region code the IP's network maps to.", "minLength": 1, "type": "string" }, "throughput": { "description": "Connection speed of the IP's network. Possible values are `low`, `medium`, `high`, or `vhigh`. IPv6 traffic is always `low`.", "type": "string", "enum": [ "low", "medium", "high", "vhigh" ] }, "timeZone": { "description": "Time zone used by the IP's network.", "minLength": 1, "type": "string" }, "zipCode": { "description": "Zip code the IP's network maps to. Multiple values are separated with `+` and ranges are separated with `-`.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/geoLocation.yaml" } }, "isEdgeIp": { "description": "Results of the verification.", "type": "boolean" } }, "x-akamai": { "file-path": "schemas/verifyLocateIpData.yaml" } } }, "x-akamai": { "file-path": "schemas/verifyLocateIp.yaml" } } } }, "headers": { "X-RateLimit-Limit": { "description": "The rate limit ceiling for this endpoint.", "example": 10, "schema": { "type": "integer" }, "x-akamai": { "file-path": "headers/X-RateLimit-Limit.yaml" } }, "X-RateLimit-Remaining": { "description": "The number of requests left for the time window.", "example": 5, "schema": { "type": "integer" }, "x-akamai": { "file-path": "headers/X-RateLimit-Remaining.yaml" } } } }, "400": { "description": "[Validation error](https://techdocs.akamai.com/edge-diagnostics/reference/400).", "content": { "application/problem+json": { "example": { "detail": "Provide only one of these members, either `edgeLocationId` or `edgeIp`.", "status": 400, "title": "Incorrect request.", "type": "bad.request.error", "errors": [ { "requestField": "edgeLocationId", "title": "Conflicting values.", "type": "field.conflict" }, { "requestField": "edgeIp", "title": "Conflicting values.", "type": "field.conflict" } ] }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/400.yaml" } }, "401": { "description": "[Authorization error](https://techdocs.akamai.com/edge-diagnostics/reference/401).", "content": { "application/problem+json": { "example": { "detail": "Inactive client token", "instance": "https://akab-nedrvuylepskzabx-lv3dgceqqktx3i5b.luna.akamaiapis.net/edge-diagnostics/v1/grep/requests", "status": 401, "title": "Not authorized", "type": "https://problems.luna.akamaiapis.net/-/pep-authn/deny" }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/401.yaml" } }, "403": { "description": "[Permission error](https://techdocs.akamai.com/edge-diagnostics/reference/403).", "content": { "application/problem+json": { "example": { "status": 403, "title": "Forbidden request.", "type": "forbidden.request.error", "errors": [ { "detail": "You don't have access to the requested URL. Contact your Admin to request access.", "requestField": "url", "title": "Field access denied.", "type": "field.access.denied" } ] }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/403.yaml" } }, "405": { "description": "[Method not allowed](https://techdocs.akamai.com/edge-diagnostics/reference/405).", "content": { "application/problem+json": { "example": { "title": "Method not allowed", "type": "method.not.allowed" }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/405.yaml" } }, "429": { "description": "[Too many requests](https://techdocs.akamai.com/edge-diagnostics/reference/429).", "content": { "application/problem+json": { "example": { "detail": "You have exceeded total number of requests configured for this API.", "status": 429, "title": "Too Many Requests", "type": "requests.exceeded.error" }, "schema": { "additionalProperties": true, "description": "Specifies the errors.", "minProperties": 1, "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "Detail about the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "[HTTP Problem Details](https://tools.ietf.org/html/rfc7807) objects indicating causes of failure.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies the error that occurred.", "type": "object", "required": [ "type", "title" ], "properties": { "requestField": { "description": "Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/sub-problem.yaml" } } }, "requestField": { "description": "Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.", "type": "string" }, "requestValues": { "description": "Lists values corresponding to the `requestField`.", "type": "array", "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Integer", "type": "integer" }, { "title": "Object", "type": "object" } ] } }, "status": { "description": "HTTP response code.", "type": "integer" }, "title": { "description": "Title of the error.", "type": "string" }, "type": { "description": "Type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "x-akamai": { "file-path": "errors/429.yaml" } } }, "parameters": [ { "description": "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ] } } }, "x-readme": { "samples-languages": [ "curl", "python", "node" ] }, "servers": [ { "url": "https://{hostname}/edge-diagnostics/v1" } ] }