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 -s https://eu2-cloud.acronis.com/api/2/clients/<your client ID> \
     --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
<...> 
{"created_by": "f90e086b...","last_access_at": "2020-05-22T10:13:28+00:00","tenant_id": "e5afb5e8...", ...}

HTTP status codes

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. See an example of such response below.
401	Cannot process a request to an endpoint because the token specified in the Authorization header is expired or invalid.
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 tenant being accessed.
404	A request to a non-existing endpoint or no requested data is found in the service.
405	A request uses a method that is not supported by the endpoint.
409	Another object of the same type already exists.
415	A request uses a format that is not supported by the endpoint. This problem might occur when an incorrect or no Content-Type header was provided in a request.
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.

Error codes

When an error occurs, the platform may respond with a JSON object in the response body containing the information about the error that will look as follows:

HTTP/1.1 400 Bad Request
<...> 

{"error":{"code":1006,"message":"It is prohibited to delete a non-disabled tenant.","details":{"info":"It is prohibited to delete a non-disabled tenant "1415032"","addition":[{"id":"1415032"}]},"context":{"id":"1415032"},"domain":"PlatformAccountServer"}}

Value	Description
error.code	A platform or HTTP code of the error. This code and its description can be found in the table below.
error.message	A short descriptive message with the error reason.
error.details	An object with additional information on the error.
error.domain	A service or service component where the error has occurred.

The following table provides the description of error codes returned by the platform in the error.code key:

Code	Description
4xx-5xx	HTTP error. See HTTP status codes.
1000	Internal system error
1001	Version mismatch
1002	Access denied
1003	Parent tenant is disabled
1004	Tenant name conflict
1005	Tenant not found
1006	Attempt to delete non-disabled tenant
1007	Attempt to move the tenant under child
1008	Moving within customer
1009	Attempt to remove storage in use
1010	Sync & Share email conflict
1011	Deprovisioning in progress
1012	Tenant is locked
1013	Attempt to move under disabled tenant
1014	Moving offering items is not available
1015	Infrastructure component conflict
1016	Attempt to turn off storage with child
1017	Attempt to turn off default storage
1018	The user is disabled
1019	Backup service is not available
1020	Attempt to register machine not by service user
1021	Offering item is not available
1022	Hard quota exceeded
1023	Offering items dependency error
1024	Address in forbidden list
1025	SMTP settings are incorrect
1026	Cannot enable service
1027	Does not satisfy business rules
1028	Guest user is already created
1029	Removing storage deprovisioning in progress
1030	Sync & Share users count quota exceeded
1031	Location conflict
1032	Target hierarchy devoid of locking tenant
1033	Invalid login
1034	Previous version of legal document is unpublished
1035	Moving offering items which are legally blocked