The Connect API provides detailed error responses to help you identify and troubleshoot issues. Errors can be returned in two different formats:
Basic error response that includes status and message fields.
Problem details response type.
Basic Error Response
When an error occurs, the API may respond with a JSON object containing the following fields:
status: An integer representing the HTTP status code indicating the type of error (e.g., 400 for Bad Request, 404 for Not Found, etc.).message: A human-readable message providing additional details about the error.
Example: Basic error response
{
"status": 404,
"message": "The requested resource was not found."
}
The status field will match the HTTP status response.
Problem Details Response
In addition to the basic error response, the Connect API also follows the standard Problem response type as described in RFC 7807. The Problem response provides more structured and consistent error information.
The Problem response includes the following fields:
type: A URI identifying the problem type. This URI helps categorise the error.title: A short, human-readable summary of the problem.status: An integer representing the HTTP status code.detail: A human-readable explanation of the problem in more detail.instance: A URI that identifies the specific occurrence of the problem. This can be useful for troubleshooting.
Example: Problem details response
{
"type": "https://example.com/errors/not-found",
"title": "Resource Not Found",
"status": 404,
"detail": "The requested resource was not found.",
"instance": "https://example.com/api/v1/users/123"
}