Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.onset.io/llms.txt

Use this file to discover all available pages before exploring further.

The Onset API is a RESTful API accessed by an HTTP client such as curl or the HTTP library, which is part of most modern programming languages. You can use this API to build custom integrations or automate even more of your organization’s workflow.
The current version of the web API is considered to be in a draft phase. While we don’t expect public endpoints to change greatly, keep in mind that the API is still under development.

​
Authentication

The Onset API uses API keys to authenticate requests. You can view and manage your API keys in the Onset Dashboard. Your API keys carry many privileges, so be sure to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth. Authentication to the API is performed via HTTP Basic Auth. Provide your API key as the basic auth username value. You do not need to provide a password. 
curl https://api.onset.io/v1/workspace \
-u {API_KEY}:
If you need to authenticate via bearer auth use -H "Authorization: Bearer API_KEY" instead of -u API_KEY. 
curl https://api.onset.io/v1/workspace \
-H 'Authorization: Bearer {API_KEY}'

​
Versioning

The API is versioned with a single number, which is currently 1. This number symbolizes the major version number, as described by SemVer. Because of this, backward-incompatible changes require this version number to change. The minor version isn’t explicit, which allows for a stable API endpoint. New features can be added to the API in the same version number. API requests must be made over HTTPS and include the API version.