API Documentation
OpenScaler API
Comprehensive guide to using OpenScaler's REST API.
Introduction
The OpenScaler API lets developers manage their resources and automate actions. The following documentation covers the endpoints, how to use them, and how to authenticate.
Authentication
Create an API token on Profile (API tokens tab). Name it, optionally set an expiry, then copy the secret (it will not be shown again).
To sign in from a terminal, use the osctl CLI.
Screenshot placeholder: Profile, API tokens tab, create form and one-shot secret reveal.
Send the secret in the Authorization header:
Authorization: Bearer os1_...Important
- Keep your secrets secure and do not share them.
- You can set expiry dates on your tokens, or revoke them if they ever get leaked or are no longer needed.
Troubleshooting
- If the request returns
401, the token is missing, revoked, or expired. Create a new API token on Profile. - If the request returns
403, the caller is authenticated but not allowed to perform that action. - If the request returns
444, initialize the account withPOST /v1/init, then retry.