Status and error codes

All API responses are assigned specific numeric codes that allow you to quickly identify if a request to an endpoint has been successful or not; and if not, why.

You may inspect response codes via curl by adding the --include option:

curl -isX GET https://eu2-cloud.acronis.com/api/notary/v2/stored-files \
     --header "Authorization: Bearer <your token>" \
     --include

Then, the first line of the response output will contain the code, which is 200 (a successful request) in the following output:

HTTP/1.1 200 OK
<...>

{"files":[],"paging":{"cursors":{}}}

Here is the summary of the response codes returned by the API, along with their descriptions. The API reference provides the list of error codes and their detailed descriptions for each endpoint.

Code

Description

20x

A request to an endpoint has been successful and the response body may contain a JSON object with the results.

400

A request to an endpoint has failed and the response body contains a JSON object with the error details. For example: {“domain”: “Notarization”, “code”: “ENOTARY”, “debug”: {“message”: “Failed to notarize file”}}. The domain key contains the operation name during which an error has occurred, the code key contains the internal error code, and the debug.message key contains the error message.

401

Cannot process a request to an endpoint because the token specified in the Authorization header of the request does not belong to any API key in the service or its API key is disabled. The response body is empty.

402

Cannot process a request to an endpoint because the quota assigned to your account for this endpoint is reached. The response body contains a JSON object with the quota usage details.

403

Cannot process a request to an endpoint because your account has no right to access this endpoint. For example, the account does not own a file being accessed. The response body is empty.

404

A request to a non-existing endpoint or no requested data is found in the service. The response body is an empty JSON object.

409

Another object of the same type already exists.

413

Cannot process a request to an endpoint because the file or object passed in the request is too large. For example, you are trying to upload a file larger than 1 GiB to the notary storage. The response body contains an HTML output with the issue reason.

50x

A service operation issue. In such cases, it is a good practice to retry the request twice with a 1-2 seconds interval. If the issue is not resolved after retrying, contact the company administrator or try again later.