This section provides details on the data object that reflects the API’s common response to error cases, and lists the API’s range of response status codes for both error and success cases.
When the API encounters an error, it responds with an error code and an error message that provides details that can be useful for debugging.
This shows a typical error response when you try to access a non-existent accessKeyUid
.
{
"type": "resource not found",
"title": "Resource Not Found",
"instance": "c135eff0-43ec-4d0e-98c9-40efb5d19f35",
"status": 404,
"detail": "Access key with accessKeyUID '12346' doesn't exist.",
"accessKeyUID": 12346
}
For details on information contained in the error responses, refer to Error response syntax.