Platform API

The API lets developers automate a set of actions required for the application lifecycle and extends the platform functionality by combining it with other services. Using our platform API, you can programmatically create environments, deploy apps, and perform other tasks that could otherwise be accomplished via the platform dashboard only (but not limited to these tasks).

Platform API follows REST principles. REST API determines a set of functions that can be requested by a developer, who then receives a response. The interaction is performed via HTTP protocol. The advantage of such an approach is a wide extension of the HTTP protocol. That's why REST API can be used in almost any programming language.

How to Use Platform API

All API calls are GET or POST HTTP requests to the URL with a set of parameters:

The required URL type is specified in the method's description (REST field).

Each method is provided with a response example. The request's response is UTF-8 encoded.

Request Parameters

Each request has a set of mandatory parameters that are required to execute the called operation. Additionally, methods can have optional parameters for the request customization (e.g. to perform extra actions). You can find a list of all parameters for a particular method within the API documentation.

All API methods require authentication and action target details, provided through the appropriate session (token) and envName (appid) parameters.

The text value of the parameters should be provided in the UTF-8 code. The sequence of the parameters in the request is not important.

Request Authentication

The session (token) parameter is responsible for authentication, i.e. it determines the user who performs the action.

You can get your session by calling the Users> Authentication> Signin method. Due to security reasons, this API method (and other ones that require a password as a parameter, e.g. signup or change password) can be called via POST request only. After obtaining a session, you can use it to authenticate and execute other methods.

It is recommended to close the working session after completing all the needed operations with API - call the Users> Authentication> Signout method.

Platform API Response

The response will not include the information of the parameter with the null value.