Skip to main content
Skip table of contents

HTTP Status Codes

When interacting with the API, responses are returned in JSON format, with various HTTP status codes indicating the outcome of the API request. The following is a detailed description of error handling based on status codes:

200 OK

Description: The request was successful, and the API returned the requested data. However, even with a 200 OK status, the desired data may not be returned if command-level authentication fails. This could occur if the user lacks permission to access specific incidents or has provided incorrect command parameters.

Response Format: application/json

Response Fields:

  • error (string): The error message if the command execution failed (empty if successful).

  • returnData (JSON Object): The data returned from the API request.

400 BadRequest

Description: The request could not be understood or was missing required parameters.

Response Format: application/json

Response Fields:

  • Error (string): A message describing the error.

401 Unauthorized

Description: Authentication failed or user does not have permissions for the desired action.

Response Format: application/json

Response Fields:

  • Error (string): A message describing the error.

429 TooManyRequests

Description: The user has sent too many requests in a given amount of time ("rate limiting").

Response Format: application/json

Response Fields:

  • Error (string): A message describing the error.

500 InternalServerError

Description: An error occurred on the server.

Response Format: application/json

Response Fields:

  • Error (string): A message describing the error.

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.