Event Viewer 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

This API responds with JSON objects that adhere to the HTTP Problem Details standard. This example shows an incorrect request error, where details explain why the error occured and incidentId may be useful if you need to communicate the problem to your Akamai support representative:

{
    "details": [
        {
            "code": "wrong.query.parameters",
            "message": "Both 'afterEventId' and 'beforeEventId' present. Only one out of those two query parameters could be specified for the same request.",
            "data": {
                "beforeEventId": "b1d9b7a7-86ce-4bf9-800e-84be19176557",
                "afterEventId": "b1d9b7a7-86ce-4bf9-800e-84be19176557"
            }
        }
    ],
    "code": "bad.request",
    "title": "Bad Request",
    "incidentId": "0d3361b0-7145-4d45-9adf-7662df2e5185"
}

HTTP Status Codes

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

Code Description
200 The operation was successful.
400 Bad Request.
401 Authentication failure.
403 Access is forbidden.
404 Resource not found.
405 Method not supported.
500 Internal server error.
503 Too many requests. Service is temporarily unavailable.

Last modified: 9/6/2017