Errors

The error response format of the Configo API and the full list of error codes.

When a request fails, the API responds with an HTTP status code and a JSON body that identifies the error.

Error format

{
  "id": 4019,
  "code": "ORDER_STATUS_NOT_FOUND",
  "message": "The order status does not exist in this project."
}

Some errors add fields with details. They are listed in the table below and on the endpoint pages.

Validation errors

REQ_VALIDATION_FAILED caused by a malformed body lists every problem in errors:

{
  "id": 2001,
  "code": "REQ_VALIDATION_FAILED",
  "message": "The request was improperly formatted or contained invalid data.",
  "errors": [
    {
      "code": "invalid_type",
      "expected": "string",
      "path": [
        "name"
      ],
      "message": "Invalid input: expected string, received undefined"
    },
    {
      "code": "too_big",
      "maximum": 100,
      "inclusive": true,
      "origin": "number",
      "path": [
        "products",
        0,
        "discount_percent"
      ],
      "message": "Too big: expected number to be <=100"
    }
  ]
}

path points to the field. errors is absent when the same code is returned for a rule checked outside the schema, for example an unknown role_uuid.

Errors without an error object

A few responses carry only {"message": "..."}:

The widget API and the OAuth token endpoints have their own formats.

Error codes

Authorization (1xxx)

Request (2xxx)

Resources (3xxx)

The API answers 404 RES_NOT_FOUND rather than 403 when the user may not see a resource, so its existence is not revealed. This includes a project whose owner's subscription has lapsed.

Business rules (4xxx)

Codes 4014–4018 come from billing operations available only to Configo's own applications.

Operations (5xxx)