Errors
Atlas Open API uses standard HTTP response codes to indicate the result of an API request.Some requests that lead to The schema below shows the structure of the error, which will be used in Specifies the type of error Provides explanation for the error Contains information about affected fields, if any name of the affected field details about the error
2xx responses indicate the success of the request. 4xx responses indicate request failure due to the information provided in the request (e.g. missing values, invalid credentials, etc). 5xx responses are due to errors in Atlas Connect's servers.4xx responses may be corrected to be processed successfully. Details are of that error are included in the response body.4xx and 5xx responses.ApiError
type
string
required
message
string
required
details
array[object (FieldError) {2}]
required
field
string
required
message
string
required
HTTP Status Codes
| status code | name | description |
|---|---|---|
| 200 | OK | Request was processed successfully |
| 401 | Unauthorized | No valid credentials provided |
| 404 | Not Found | The requested resource does not exist |
| 422 | Unprocessable Entity | Request not processed due to invalid data |
| 500 | Server Error | Request not processed due to invalid data |
API Error Types
| type | description |
|---|---|
| Not Found | The requested resource does not exist |
| Unauthorized | No valid credentials provided |
| Invalid Parameter | Request failed due to invalid parameters provided in the request. Can be retried after making adjustments to the request. |
| Configuration Required | Configuration might be required to process the request. If you think your request is valid, contact us for assistance. |
| Server Error | Request not processed due to invalid data |