Magnolia 5.7 reached extended end of life on May 31, 2022. Support for this branch is limited, see End-of-life policy. Please note that to cover the extra maintenance effort, this EEoL period is a paid extension in the life of the branch. Customers who opt for the extended maintenance will need a new license key to run future versions of Magnolia 5.7. If you have any questions or to subscribe to the extended maintenance, please get in touch with your local contact at Magnolia.
This page describes the most common types of errors (exceptions) that may occur when issuing API requests.
A server may respond to a REST API request with an HTTP response message informing about the failure of the API call. For example, if you send a simple request such as:
https://demopublic.magnolia-cms.com/.rest/delivery/tours/v1/magnolia-travels/A-Taste-of-Asia
the sever responds with the following message in the body of the response:
{
"error": {
"code": "pathNotFound",
"message": "/magnolia-travels/A-Taste-of-Asia"
}
}
The message informs the receiver about an exception that occurred while processing the request: the requested resource path was not found on the server.
Exception types
The tables below describe several common types of exceptions, their HTTP status codes and error codes. For exceptions not mentioned below, the status code is 500 and the error code is unknown.
JAX-RS exceptions
| Exception | HTTP Status Code | Error code | Description |
|---|---|---|---|
NotAuthorizedException | 401 | notAuthorized | Unauthorized. |
BadRequestException | 400 | badRequest | Bad request. |
NotAllowedException | 405 | methodNotAllowed | The request method is not supported. |
NotAcceptableException | 406 | notAcceptable | The requested media type is not supported. |
NotFoundException | 404 | notFound | The resource was not found. |
ReaderException | 400 | readerError | A JAX-RS exception. |
WriterException | 500 | writerError | A JAX-RS exception. |
Repository exceptions
| Exception | HTTP Status Code | Error code | Description |
|---|---|---|---|
AccessDeniedException | 403 | accessDenied | Access is denied. |
NoSuchNodeTypeException | 500 | noSuchNodeType | The requested node type was not found. |
NoSuchWorkspaceException | 500 | noSuchWorkspace | The requested workspace is not configured. |
ValueFormatException | 400 | invalidValueFormat | The value format is invalid. |
InvalidQueryException | 400 | invalidQuery | The query is invalid. |
PathNotFoundException | 404 | pathNotFound | The requested resource path was not found. |
Exception response format
The format of an exception response to be returned is determined as follows:
- The response is displayed in the media type requested (see IANA's Media Types).
- If the requested media type is not supported, JSON is returned as fallback.
If no resource method is matched, JSON is returned as fallback.
The nodes and properties endpoints no longer always return exceptions in plain text.
Overview
Content Tools