Error responses for all routes

Here you will find details of the HTTP error responses that could occur with any route. Responses specific to a particular route will be found in the section for that route.

400 - Bad Request

The server could not understand the request due to invalid syntax.

Example

401 - Unauthorized

Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response.

Example

403 - Forbidden

The client does not have access rights to the content, i.e. they are unauthorized.

Example

{
    "type": "Forbidden",
    "code": 403,
    "message": "Invalid API key.",
    "name": "ForbiddenError"
}

404 - Not Found

The requested route or resource could not be found.

Example

{
    "type": "NOT_FOUND",
    "code": 404,
    "message": "Not found",
    "name": "NotFoundError"
}

422 - Unprocessable Entity

Usually means that a required parameter is missing from the request body.

{
    "type": "VALIDATION_ERROR",
    "code": 422,
    "message": "Parameters validation error!",
    "data": [
        {
            "keyword": "required",
            "dataPath": "",
            "schemaPath": "#/required",
            "params": {
                "missingProperty": "name"
            },
            "message": "should have required property 'name'"
        }
    ],
    "name": "ValidationError"
}

500 - Internal Server Error

The server has encountered a situation it doesn't know how to handle. There will be further details in the response.

Example

{
    "type": "ERR_SSAI_API",
    "code": 500,
    "message": "SSAI API update error",
    "data": "id cannot be changed",
    "name": "MoleculerError"
}