Diagnostic Tools API Debugging

This section provides details on the data object that reflects the API’s common response to error cases, and lists the API’s range of response status codes for both error and success cases.

Error Responses

In case of error, this API responds with JSON objects that follow the HTTP Problem Details standard. The following shows a typical error response object:

{
    "type": "https://problems.luna.akamaiapis.net/diagnostic-tools/bad-request",
    "title": "Bad Request",
    "status": 400,
    "detail": "Invalid Argument",
    "instance": "/diagnostic-tools/v2/ip-addresses/61.213.151.92/log-lines?startTime=2016-02-10T00:00:00Z&noOfMins=10&noOfLogLines=10000",
    "method": "GET",
    "requestTime": "2016-02-10T22:18:20.505Z",
    "errors": [
        {
            "error": "Invalid noOfLogLines query param. Limit is 5000",
            "fieldName": "noOfLogLines"
        }
    ]
}

HTTP Status Codes

This section lists the full range of response codes the API may produce.

Code Description
200 The operation was successful. This also results from polling an ongoing process.
202 Resource successfully accepted. This signals the start of an asynchronous process.
303 The requested item is available at the link provided, once the asynchronous process completes.
400 Bad Request.
403 Access is forbidden. This error typically occurs for tools that depend on certain features being available under your product and contract.
404 Resource not found.
429 Too many requests. This API operation is rate-limited.
500 Internal server error.
502 Platform timeout error.
503 Service is temporarily unavailable.

Last modified: 5/4/2017