The API empowers developers to streamline a series of essential actions throughout the application lifecycle and enhances the platform\u2019s capabilities by integrating it with various services. Through our platform API, you have the capability to automatically generate environments, launch applications, and conduct additional tasks that were previously exclusive to the platform dashboard (though not restricted to these responsibilities).<\/p>\n
The Platform API adheres to REST principles. A REST API defines a collection of functions that developers can request and subsequently receive a response for. This interaction occurs through the HTTP protocol. The benefit of this methodology lies in the extensive reach of the HTTP protocol, enabling the REST API to be compatible with nearly all programming languages.<\/p>\n
All API calls are\u00a0GET<\/b>\u00a0or\u00a0POST<\/b>\u00a0HTTP requests to the URL with a set of parameters:<\/p>\n
https:\/\/[hoster-api-host]<\/a>\/1.0\/<\/p>\n [hoster-api-host]<\/a> – You can get this information from here<\/a>. The “User Environment Domain(s)” field corresponds to the URL type for API access.<\/p>\n Each method is provided with a response example. The request’s response is\u00a0UTF-8<\/b>\u00a0encoded.<\/p>\n 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.<\/p>\n All API methods require authentication and action target details, provided through the appropriate\u00a0session (token) (mandatory)<\/i><\/b>\u00a0and\u00a0envName (appid) <\/i><\/b>\u00a0parameters.<\/p>\n 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.<\/p>\n The\u00a0session (token)<\/b>\u00a0parameter is responsible for authentication, i.e. it determines the user who performs the action.<\/p>\n You can get either generate session id<\/strong><\/span> or you can use API token<\/strong><\/span> for this parameter.<\/p>\n API Token<\/strong><\/span> – You can generate API toke from the user account. Here is how you can generate API access token<\/a>.<\/p>\n Session ID<\/strong><\/span> – You can get your session by calling the Users> Authentication> Signin<\/b><\/a>\u00a0method. 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.<\/p>\nRequest Parameters<\/h2>\n
Request Authentication<\/h2>\n