Cherry Servers API Docs (1.0.0)

Download OpenAPI specification:Download

Authentication

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.

Response codes

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.

Common parameters

List parameters:

Limit Ofset X-Total-Count header

More params: query parameter fields

Images

Retrieve plan oses

path Parameters
planId
required
string
query Parameters
fields
required
string
Default: "images,pricing"
limit
string \d+
Default: 0
offset
string \d+
Default: 0

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve custom plan oses

path Parameters
teamId
required
string
planId
required
string
query Parameters
fields
required
string
Default: "images,pricing"
limit
string \d+
Default: 0
offset
string \d+
Default: 0

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Invitations

Retrieve team invitations

path Parameters
teamId
required
string
query Parameters
fields
required
string
Default: "invitation,href"
limit
string \d+
Default: 0
offset
string \d+
Default: 0

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Send inviation

path Parameters
teamId
required
string
query Parameters
fields
required
string
Default: "invitation,href"
Request Body schema: application/json
email
required
string

invitee email

message
required
string
Default: ""
projects
Array of any
roles
required
Array of any ROLE_ADMIN|ROLE_BILLING|ROLE_COLLABORATOR
Default: "ROLE_COLLABORATOR"

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "message": "",
  • "projects":
    [
    ],
  • "roles": "ROLE_COLLABORATOR"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "href": "string",
  • "invitee": "string",
  • "message": "string",
  • "updated": "2019-08-24T14:15:22Z",
  • "created": "2019-08-24T14:15:22Z",
  • "invited_by":
    {
    },
  • "team":
    {
    },
  • "roles":
    [
    ],
  • "projects":
    [
    ]
}

View an invitation

path Parameters
invitationId
required
string
query Parameters
fields
required
string
Default: "invitation,href"

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "href": "string",
  • "invitee": "string",
  • "message": "string",
  • "updated": "2019-08-24T14:15:22Z",
  • "created": "2019-08-24T14:15:22Z",
  • "invited_by":
    {
    },
  • "team":
    {
    },
  • "roles":
    [
    ],
  • "projects":
    [
    ]
}

Accept invitation

path Parameters
invitationId
required
string
query Parameters
fields
required
string
Default: "membership,href"

Responses</