ApiErrorResponse
ApiErrorResponse
Standard API error response envelope
JSON Example
{
"errorCode": "string",
"message": "string",
"path": "string",
"timestamp": "string",
"reason": "string"
}
errorCode
Required
Stable machine-readable error code. The known values are listed in ApiErrorCode; the set is not closed, so a client must tolerate an unlisted value.
string
message
Required
Human-readable error description
string
path
Required
Request URI path that produced the error
string As date-time
As date-time
timestamp
Required
Timestamp when the error occurred as an ISO 8601 date-time with offset
string
reason
Optional
A finer code, present only where an endpoint documents it. The Rule Pack endpoints' PACK_ENTRY_INVALID carries the import core's code here.
Returned By