Jelastic Cloud API

lets developers to automate a set of actions required for application lifecycle and extend our platform functionality by combining with other services. Using our API you can programmatically create environments, deploy apps and perform other tasks that could be earlier accomplished only via Jelastic dashboard but not limited to them.

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

How to use Jelastic API

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

Which type of the URL should be used is stated in the description of each method (REST field).

The request response is UTF-8 encoded. An example of the result is described in the documentation of the method.

The Request Parameters

Request should contain a set of the mandatory parameters. There are some additional parameters required for a particular function. Such parameters are stated in the instruction about this function.

Each request includes the mandatory appid parameter identifying the requested environment.

If the request is not connected with the environment, as an appid parameter there should be used the system value 1dd8d191d38fff45e62564fcf67fdcd6

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

The Request Authentication

The parameter session is responsible for authentication, i.e. determining the user with the request.

Session is achieved by calling the Users> Authentication> Signin method. The further calling of the API functions should be performed with the received session value.

To complete the working session with API, call the Users> Authentication> Signout method.

Jelastic API Response

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