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.

If you encounter any errors when running the Live Archive Management API, the API responds with an error code and an error message that provides details useful for debugging.

This shows a typical error response you get when a request is made for a stream ID for which you don’t have read permission:

  "type": "",
  "title": "Forbidden",
  "status": 403,
  "instance": "",
  "method": "GET",
  "serverIp": "",
  "clientIp": "",
  "requestId": "142558a",
  "requestTime": "2018-06-22T10:41:58Z"

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