Errors

In this guide, we will talk about what happens when something goes wrong while you work with Inspektre API. Let's look at some status codes and error types you might encounter.

you can tell if your request was successful by checking the status code when receiving an API response. If a response comes back unsuccessful, inspektre uses the error type and error message to figure out what has gone wrong and do some rudimentary debugging (before contacting support).

Before reaching out to support with a support request, Please ensure that you have captured sufficient details. This will greatly assisst inspektre support in helping alleviate the error.

Status codes

Here is a list of the different categories of status codes returned by the Inspektre API. Use these to understand if a request was successful.

  • Name
    2xx
    Type
    Description

    A 2xx status code indicates a successful response.

  • Name
    4xx
    Type
    Description

    A 4xx status code indicates a client error — this means it's a client-side tooling error problem.

  • Name
    5xx
    Type
    Description

    A 5xx status code indicates a server error — We hope you won't be seeing these.

Error types

Whenever a request is unsuccessful, the Inspektre API will return an error response with an error type and message. inspektre uses this information to understand better what has gone wrong and how to fix it. Most of the error messages are pretty helpful and actionable.

Here is a list of the two error types supported by the Inspektre API — use these to understand what went wrong.

  • Name
    api_error
    Type
    Description

    While this is unlikely, This means that something unexpected occured on our end. Please notify support. Most likely, our teams have already been notified to react to events including api_error.

  • Name
    invalid_request
    Type
    Description

    An error occured with consumption of Inspektre API at your end. Please check Inspektre API Usage (documentaion)[/apidocs]. Most common reasons for invalid_request occur when using a wrong HTTP METHOD, when missing authentication, when there is missing data or when mistakes occur in spellings typo.

Error response

{
  "type": "api_error",
  "message": "No way this is happening!?",
  "documentation_url": "https://docs.inspektre.io/errors/api_error"
}