Overview
Errors
Sidecar CX uses conventional HTTP status codes to indicate the success or failure of an API
request. Codes in the range of 2xx indicate a successful request and will often return a response
body. Codes in the range of 4xx indicate errors that failed the given request. An error message is
provided to help indicate what the issue is and in many cases can be handled programmatically to
take proper action. Codes in the 5xx range indicate an error with the Sidecar CX service
and are considered rare.
In some circumstances, additional information is provided in the extra field of the response body
when an error occurs.
Below you will find the error status codes that the Sidecar CX service can return.
400 - Bad Request.401 - The request requires user authentication.403 - The server understood the request, but is refusing to fulfill it.404 - The server has not found anything matching the Request-URI.405 - The method specified in the Request-Line is not allowed for the resource identified by the Request-URI.408 - The request timed out.409 - The request conflicts with another request, likely due to a duplicate resource.429 - Too many requests were sent to the server too quickly.500 - The server encountered an unexpected condition which prevented it from fulfilling the request.502 - Bad gateway.503 - Service is unavailable.
Error Response - [Map]
An object to describe the error that occurred.
Attributes
- errorCode - REQUIRED[Integer]
A custom error code to uniquely identify the problem.
- extra - OPTIONAL[Map]
Contains any additional information about the error.
- message - REQUIRED[String]
A message identifying what went wrong.
{"errorCode": 0,"extra": {},"message": "string"}