Response codes

ATLAS API Response codes

The OpenAPI spec only documents success codes.

ATLAS API response codes

Success

CodeMeaningUsed by
200 OKRequest succeeded and a body is returnedAll 224 GETs, 75 PUTs, 80 PATCHes, 24 POSTs (search, login, sas_token, and other non-create POSTs)
201 CreatedResource created114 POSTs (create endpoints, e.g. POST /asset/)
204 No ContentSucceeded with no body65 DELETEs and 1 POST

Client errors

  • 400 Bad Request: the payload failed validation, for example a missing required field such as tenant_id/contract_id or a wrong type. The body is usually a JSON object keyed by field name. This error code is also returned when there is a changeset conflict while publishing or sharing a chageset.
  • 401 Unauthorized: the bearer token is missing, invalid or expired. Log in again at POST /authentication/login/.
  • 403 Forbidden: the token is valid but the user lacks the privilege or tenant access.
  • 404 Not Found: the resource ID or path doesn't exist, or the user can't see it.
  • 405 Method Not Allowed: the HTTP verb isn't supported on that path.
  • 415 Unsupported Media Type: the wrong Content-Type, for example sending form data where JSON is expected.
  • 429 Too Many Requests: throttled, if throttling is enabled.

Server errors

  • 500 Internal Server Error: unhandled backend error.
  • 502/503/504: gateway or availability problems. The upload samples already retry on any status below 500, so a 5xx there is treated as a failure.