Whenever something goes wrong with an API request, the server produces an error. The error message contains an appropriate HTTP status code in the header and a JSON response in the body. The
sys part of the JSON describes the error details.
sys.type will always be Error, and the
sys.id identifies the precise error that has occurred. The error messages sometimes include more details about the error.
The API has a set of well-defined errors that it responds with if something didn't work out.
|HTTP status code||Error code||Description|
| || ||The request was malformed or it is missing a required parameter.|
| || ||The request contained invalid or unknown query parameters.|
| || ||The authorization token was invalid.|
| || ||The user tried to access a resource that they do not have access to. This could include a missing role.|
| || ||The requested resource or endpoint could not be found.|
| || ||This error happens when you're trying to update an existing asset, entry or content type, and you either didn't specify the current version of the object or specify an outdated version.|
| || ||The request payload was a valid JSON, but something was wrong with the data. Check the error details field – it should provide more specific information about the error.|
| || ||The triggered query references an invalid field.|
| || ||The entered value is invalid.|
| || ||The user sends too many requests per second.|
| || ||Something went wrong on our end.|
| || ||The space has not been used for a long time and hence it has been hibernated, but it will reappear if the user begins using it again.|