Sometimes requests to the API are not successful. Every time, the API returns an HTTP Status Code that indicates the nature of the failure, with a response body in JSON format containing additional information.
HTTP Status Errors
Code | Meaning | How to interpret |
---|---|---|
200 | Success | The request has succeeded. |
400 | Bad Request | Request has missing arguments or is malformed. |
401 | Unauthorized | Check your authorization credentials. |
403 | Forbidden | Request is authenticated but has insufficient permissions. |
404 | Not Found | Wrong URL or parameters. |
422 | Unprocessable Entity | May be: wrong validation, wrong parameter, out of range, wrong input. |
500 | Internal Server Error | The server encountered an unexpected condition that prevented it from fulfilling the request. Most likely, you don't have enough permissions. |
API Limitations
Rate Limiting
500 API calls per minute for POST
request. Among the most popular requests you may reach the limit with are:
persistentStorage
dns/{tenantIdentifier}
dns/records/{tenantIdentifier}
tenants/store
templates/addtemplate
vmlist/create
kubernetes/cluster
{tenantIdentifier}/loadBalancer
cluster/database
{tenantIdentifier}/firewall
Device Storage Adding
Instance | Limitation |
---|---|
ramvalue |
Min: 1; Max: 12 |
cpuvalue |
Min: 1; Max: 128 |
Formats
For date parameters (such as startDate
and endDate
ones), we use the ISO8601 format:
YYYY-MM-DD. Example: 2022-02-21
.