API Documentation
OpenScaler API
Comprehensive guide to using OpenScaler's REST API.
Introduction
The OpenScaler API lets developers manage their resources, automate actions easily. The following documentation will go through the different endpoints and how to use them, as well as how to authenticate your requests.
Authentication
OpenScaler API uses OAuth, a standard for secure authorization.
To access the API, you can obtain a token via the your profile page.
Then paste your token in the Authorization header for requests:
Important
- Always keep your token secure and do not share it with anyone!
- The token is short-lived and might expire, after which you'll get
403 Access Deniederror on your API requests. - Your copied token will include the
Bearerprefix.
Projects
Most resources are scoped in projects and many endpoints require a project ID. You can get your project ID with the Get Projects Endpoint.