Error handling

Error response information

If an error occurs during a request, the following fields will be returned in the response body:

Name Description Type
Status HTTP status code integer
Code Error code string
Message Error message string
CorrelationId Correlation ID (for traceability and and troubleshooting) string

HTTP status codes

We use the following HTTP status codes:

  • 200 - OK
  • 400 - Bad Request
  • 401 - Unauthorized
  • 403 - Forbidden
  • 404 - Not Found
  • 415 - Unsupported Media Type
  • 500 - Internal Server Error
  • 501 - Not Implemented
  • 504 - Gateway Timeout

Error codes

We use the following error codes:

  • AccessDenied
  • AuthenticationFailed
  • BadRequest
  • FeatureNotEnabled
  • InternalServerError
  • NotFound
  • NotImplemented
  • NotSupported
  • ServiceUnavailable
  • Timeout
  • UnsupportedMediaType