Using the StarLeaf Cloud API
Last updated April 20, 2021 Cloud API
The StarLeaf Cloud API is a RESTful API that enables external clients to manage StarLeaf deployments and services.
This document defines the Cloud API and describes its usage.
To use the API, the client must make HTTPS requests to the StarLeaf Cloud API server: https://api.starleaf.com/v1
The body type for all POST and PUT requests must be of type application/json.
GET and DELETE requests do not require a body. Where the server response includes a body, it is also of type application/json. Strings must be UTF-8 encoded. All responses include the header X-SL-SERVER, which identifies the server from which the response came. The client should include this information in any logs, to assist with debugging any issues.
Details of the requests, together with the specification of the associated JSON bodies, are given in the following sections. Where a field is defined as being optional, then it may be omitted from the request body, in which case the default value is used. Response bodies may contain additional optional fields that are not described in this specification.
We recommend that clients do not rely on the default value of boolean arguments. StarLeaf may change any default value in a future release.
Before the client can make any API requests, the client must first authenticate itself with the StarLeaf Cloud API server. Clients authenticate with the StarLeaf platform as an integration which is effectively a ‘dummy’ user which can either have administrator access to the organization or not.
Authentication header method
This allows a client to authenticate with the StarLeaf platform as a ‘dummy’ user. You can use this as the authentication method for clients that will create and manage conferences. Such a client can also request a feature list and the software version of the server. If you give the integration ‘admin’ privileges, it can also create users in its own organization. Such a client cannot be associated with a real user; therefore the conferences it creates would not belong to a ‘real’ owner. Such a client cannot access the Cloud with reseller privileges.
For more information, refer to Authentication using authentication header method