Errors

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

If an error occurs, this API responds with JSON objects that provide information you can use to debug the problem. This sample shows a bad request error, where the title is a descriptive label for the overall problem, and the instance may be useful if you need to communicate the problem to your Akamai support representative. It also includes an optional errors array that lists potentially more than one problem detected in the request.

{
  "type": "bad-request",
  "title": "Erroneous data input",
  "instance": "8ed959ae-bc22-43f4-893c-2f293518f258",
  "status": 400,
  "errors": [
    {
      "type": "bad-request",
      "title": "Bad Request",
      "instance": "1664e1a7-d916-4cf9-944f-2d9f6d176f8f",
      "detail": "Expiry Date of Previous Key is required"
    }
  ]
}

The List streams and Get a stream operations return objects that may indicate stream failure errors, such as ACTIVATION_ERROR or UNEXPECTED_SYSTEM_ERROR. To perform any action on a failed stream, contact technical support.

{
  "type": "UNEXPECTED_SYSTEM_ERROR",
  "title": "Unexpected System Error",
  "detail": "Version 1 of stream5 has failed to activate after an unexpected system error. For assistance, contact technical support."
}

For details on information contained in the error responses, refer to Error response syntax.