Category / Section
Which is more preferable: API-Result-Header x-error or API response body error
Published:
The x-error is an HTTP custom response header that is returned in tenant site API
response when an error occurs. It contains the error message details.
Error occurs in API when the server receives a request from the client then some issues like server-side error, request body
that was improperly formatted, or etc occurred. The actual error details will be sent in the response body in the
Message property and same message will be available in x-error header.
We advise to inspect the response body directly.
Note: Error message will not contain any sensitive information such as passwords or personal data and it will only contain the generic error detail.
Related links
Related links