The Security Monitor API Debugging

This section provides details on the error response format and the range of response codes.

Error Responses

The API returns the error JSON below for all non–2xx HTTPS status codes. The response code corresponds to the httpStatus element in the JSON response. This helps you avoid querying the header for the response code.

HTTP/1.1 404 Not Found

Content-Type: application/json
Reply Body:
{
    "httpStatus": 404,
    "detail": "additional non-http specific info where relevant",
    "title": "Resource not found"
}

HTTP Status Codes

The API can return any one of the following response codes:

Code Description
200 OK
204 No data
400 Bad input parameter. Error message indicates which one and why.
401 Authentication failure
403 Authorization failure
404 Resource not found
405 Request method not expected (generally should be GET)
409 Conflict
410 Requested resource is no longer available.
411 Content-length header not specified
413 Request body exceeds maximum allowable size.
423 Requested resource is locked.
429 Request rate limit exceeded. [See here][rateLimit]
500 Internal server error unexpected condition
501 Not supported
503 Too many requests; service is temporarily unavailable.
507 Data size is over allowable limit.

Last modified: 12/12/2016