API
Search…
HTTP Status Codes

2xx

HTTP
Status Code
Meaning
Possible Reason(s)
200
  • OK
  • Any method finished successfully
201
  • Created
  • POST method on an entity inserted new data successfully

3xx

HTTP
Status Code
Meaning
Possible Reason(s)
304
  • Not Modified
  • ETag: GET method with "If-None-Match" header if an entity has not been changed

4xx

HTTP
Status Code
Meaning
Possible Reason(s)
400
  • Bad request
  • Invalid body, query parameter or path parameter
  • An entity in the request body failed a validation
401 [1]
  • Authentication error
  • Missing or invalid "Authorization" header
403 [1]
  • Authorization error
  • Invalid or expired access token (JWT)
  • Insufficient permissions
404
  • Invalid or non-existent resource ID
  • GET method did not find any entity matching the filter
409
  • Conflict
  • PUT or PATCH method on an entity if the "versionDate" verification fails
412
  • Precondition Failed
  • ETag: PUT or PATCH method with "If-Match" header if an entity has been changed
428
  • Precondition Required
  • ETag: PUT or PATCH method on an entity called without the "If-Match" header
[1] The error response for status codes 401 and 403 has an extra field reason so as to further differentiate the situations programmatically. The value is an enumeration and can be one of these:
"reason"
"status"
Meaning / more detailed reason
INVALID_AUTH_HEADER
401
The Authorization header is missing or has an invalid value.
INVALID_REFRESH_TOKEN
401
The refresh token is invalid (not found).
BAD_REGISTRATION
401
Internal error - call the support.
UNAUTHORIZED
401
Not authorized with no specific reason given.
AUTHENTICATION_FAILED
401
Generic authentication error - call the support.
INVALID_ACCESS_TOKEN
403
The access token cannot be parsed or the signature verification failed.
ACCESS_TOKEN_EXPIRED
403
The access token has expired. Sign in again.
CLOUD_FORBIDDEN
403
The access to the given cloud is not allowed.
DOMAIN_FORBIDDEN
403
The access to the endpoint path is not allowed.
ACCESS_DENIED
403
The access is denied with no specific reason given.
AUTHORIZATION_FAILED
403
Generic authorization error - call the support.

5xx

HTTP
Status Code
Meaning
Possible Reason(s)
500
  • Internal Server Error
  • Any method unexpectedly failed
501
  • Not Implemented
  • Feature has not been implemented yet.

Last modified 6mo ago
Export as PDF
Copy link
Contents
2xx
3xx
4xx
5xx