HTTP - Management
Error
Created by Contensis product team, last modified by s.yearsley on 24 Sep 2020
Status codes and error responses you can encounter when using the API. The Management API returns error details in a generic format so that it can be easily handled in a consistent way. Detailed error information is not exposed in the response to ensure security sensitive details are not leaked.
Typical HTTP status codes
Below are the current status codes returned from the Management API.
| Status code | Error code | Description |
|---|---|---|
| 400 | Bad request | The request could not be understood or was missing required parameters. |
| 401 | Unauthorized | The user has not been authenticated. |
| 403 | Forbidden | The action is not authorized for the current user. |
| 404 | Not found | The resource was not found. |
| 422 | Validation error | One or more validation errors have occurred. |
| 409 | Conflict | A given value is invalid for the current state of the resource. |
| 500 | ServerError | An error occurred on the server. Something went wrong processing the request. |
Properties
| Name | Data type | Data format | Description |
|---|---|---|---|
| logId | string | uuid | This can be used within the Contensis log search to understand further details about the error. |
| message | string | A description of the error. | |
| data | any | An object containing specific data relevant to the error. | |
| type | string | The type of error - for the Delivery API, this will always be error. |
Example
Example error response
{
"logId": "63cb1df0-b82a-459e-accc-635e187f3b8b",
"message": "An error occurred requesting the entry",
"data": {
"entryId": "ba8a92bd-0e5f-465e-acec-3cdb3db38df6",
"projectId" "moveiDb"
},
"type": "error"
}