Error Responses

On this page

All error responses (logical or caught exceptions) are in JSON format as:

{
  "message" : "error details",
  "status" : errorCode
}

Handled exceptions do not expose stack traces, to avoid security threats. Detailed stack traces are logged to the server logs for diagnostics.

Properties Returned

Table: Error Responses

Element	Type	Description
message	string	Detailed message of the exception.
status	errorCode	The HTTP response status code (e.g. 500, 403).

The response message when a UUID is expected:

Example: Caught Exception

Request:

GET /systems/badparm

Response:

{
  "status" : 404,
  "message" : "UUID is malformed"
}