Download OpenAPI specification:Download
Most of the endpoints require authentication. Authenticating is done with an Bearer Token in the Authorization
header.
curl -H 'Authorization: Bearer my_authentication_token'
Authentication tokens are used to identify the user your application is connecting to the Cherry Servers API on behalf of. Think of authentication tokens as permanent sessions—the user creates authentication tokens, and your app can use them to connect to the API on their behalf until they delete the token.
Users can create authentication tokens in the Cherry Server client portal.
Codes in the 2xx range indicate success. Codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted, a charge failed, etc.). Codes in the 5xx range indicate an error with internal servers.
200, 201, 204 | Everything worked as expexted. |
400 | Bad parameters or request can't be made. |
401 | No valid API key provided. |
403 | Insufficient permissions to access resource. |
404 | Resource doesn't exist. |
500 | Something went wrong. |
List parameters:
Limit Ofset X-Total-Count header
More params:
query parameter fields
planId required | string |
fields required | string Default: "images,pricing" |
limit | string\d+ Default: 0 |
offset | string\d+ Default: 0 |
Returns list of available operating systems
teamId required | string |
planId required | string |
fields required | string Default: "images,pricing" |
limit | string\d+ Default: 0 |
offset | string\d+ Default: 0 |
Returns list of available operating systems
serverId required | string |
fields required | string Default: "images,pricing" |
limit | string\d+ Default: 0 |
offset | string\d+ Default: 0 |
Returns server plan available images
teamId required | string |
fields required | string Default: "invitation,href" |
limit | string\d+ Default: 0 |
offset | string\d+ Default: 0 |
Returns team invitation list
teamId required | string |
fields required | string Default: "invitation,href" |
email required | string invitee email |
message required | string Default: "" |
projects | Array of any |
roles required | Array of anyROLE_ADMIN|ROLE_BILLING|ROLE_COLLABORATOR Default: "ROLE_COLLABORATOR" |
Create invitation
invitationId required | string |
fields required | string Default: "invitation,href" |
Get invitation
invitationId required | string |
fields required | string Default: "membership,href" |
Accept invitation
List of free project ip addresses.
projectId required | string |
fields required | string Default: "ip,href,region" |
region required | string <RegionConstraint> |
Returns list of available ip addresses
projectId required | string |
fields required | string Default: "ip,href,region" |
limit | string\d+ Default: 0 |
offset | string\d+ Default: 0 |
type | Array of anysubnet|primary-ip|floating-ip|private-ip |
Returns list of ip addresses
projectId required | string |
fields required | string Default: "ip,href" |
region required | string <RegionConstraint> Available regions |
routed_to | string Server primary or secondary ip |
ptr_record | string |
a_record |