logo

Errors

The Honeycomb API returns standardized error responses, as documented here.

Error

A legacy error, containing only a textual description.

error
string
{
  • "error": "string"
}

JSONAPIErrors

A JSONAPI-formatted error message.

Array of objects
{
  • "errors": [
    ]
}

DetailedError

An RFC7807 'Problem Detail' formatted error message.

error
required
string
Default: "something went wrong!"
status
required
number

The HTTP status code of the error.

type
required
string

Type is a URI used to uniquely identify the type of error.

title
required
string

Title is a human-readable summary that explains the type of the problem.

detail
string

The general, human-readable error message.

instance
string

The unique identifier (ID) for this specific error.

{
  • "error": "something went wrong!",
  • "status": 0,
  • "type": "string",
  • "title": "string",
  • "detail": "string",
  • "instance": "string"
}

ValidationError

An RFC7807 'Problem Detail' formatted error message.

error
required
string
Default: "something went wrong!"
status
required
number
Default: 422

The HTTP status code of the error.

type
required
string
Default: "https://api.honeycomb.io/problems/validation-failed"

Type is a URI used to uniquely identify the type of error.

title
required
string
Default: "The provided input is invalid."

Title is a human-readable summary that explains the type of the problem.

detail
string

The general, human-readable error message.

instance
string

The unique identifier (ID) for this specific error.

Array of objects
{
  • "error": "something went wrong!",
  • "status": 422,
  • "type": "https://api.honeycomb.io/problems/validation-failed",
  • "title": "The provided input is invalid.",
  • "detail": "string",
  • "instance": "string",
  • "type_detail": [
    ]
}