Skip to main content

ErrorModel

detailstring

A human-readable explanation specific to this occurrence of the problem.

Example: Property foo is required but is missing.
errors object[]nullable

Optional list of individual error details

  • Array [
  • locationstring

    Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'

    messagestring

    Error message text

    value

    The value at the given location

  • ]
  • instanceuri

    A URI reference that identifies the specific occurrence of the problem.

    Example: https://example.com/error-log/abc123
    statusint64

    HTTP status code

    Example: 400
    titlestring

    A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

    Example: Bad Request
    typeuri

    A URI reference to human-readable documentation for the error.

    Default value: about:blank
    Example: https://example.com/errors/example
    ErrorModel
    {
    "detail": "Property foo is required but is missing.",
    "errors": [
    {
    "location": "string",
    "message": "string"
    }
    ],
    "instance": "https://example.com/error-log/abc123",
    "status": 400,
    "title": "Bad Request",
    "type": "https://example.com/errors/example"
    }