API Errors

All API errors follow the RFC 7807 Problem Details format.
Every error response contains a machine-readable type and code, along with optional human-readable fields.

---

Problem Details Structure

Problem/Error Details

{
  "type": "https://example.com/probs/ERROR_CODE",
  "code": "ERROR_CODE",
  "title": "Short human-readable summary of the problem",
  "status": 400,
  "detail": "More detailed explanation of the error",
  "instance": "/path/of/the/request"
}

HTTP Client Error Status Codes

Status Code	Description	Summary
400	Bad Request	The request was unacceptable or malformed, often due to missing a required parameter.
401	Unauthorised	The request is not from an authenticated source.
403	Forbidden	The request is authenticated but does not have permissions to perform the request.
404	Not Found	The requested resource doesn’t exist.

HTTP Server Error Status Codes

Status Code	Description	Summary
500	Internal Server Error	The Apicunia server has encountered a situation it does not know how to handle.
502	Bad Gateway	Whilst the Apicunia server was working as a gateway to get a response, got an invalid response.
503	Forbidden	The Apicunia server is not able to handle the request, perhaps down for maintenance or overloaded.
504	Not Found	The Apicunia server was working as a gateway to get a response and cannont get a response within the alloted time.

Error Codes

Code	Description
FORMAT_ERROR	Incorrect data format has been provided, not compliant with the expected specifications (e.g., invalid JSON format, missing or incorrectly formatted fields).
CLIENT_INVALID	The client is not recognised or is invalid (an attempt to access resources by an unauthorised client).
CLIENT_INCONSISTENT	The client information provided in the certificate and/or in the request message body is not consistent with related directory information.
TIMESTAMP_INVALID	The timestamp provided in the request is invalid (incorrect format, value in the future, or if it exceeds the allowed validity period by the system).