API problem format

The API problem format refers to the way Palisade describes errors returned by the API.

When users attempt to carry out an action that results in an error, the API will return an error message.

This error message will comprise the following:

• A human-readable message
• A reason
• A request ID

If you are unsure how to fix the error, please email [email protected] with the error message and the team will be able to assist.

Example

This is an example of what an error message looks like:

{
    "code": 123,
    "message": "validation error: - name: value length must be at least 1 characters [string.min_len].",
    "details": [
        {
            "@type": "type.googleapis.com/google.rpc.ErrorInfo",
            "reason": "PAL000.000",
            "domain": "app.development.palisade.co/api",
            "metadata": {}
        },
        {
            "@type": "type.googleapis.com/google.rpc.RequestInfo",
            "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517",
            "servingData": ""
        }
    ]
}