SenseOn Connect API Reference
SenseOn Connect is a bidirectional API that allows programmatic interaction with most data within the SenseOn platform.
Compatibility: The API is only supported on cloud-hosted SenseOn instances. It is not currently available for on-premise installations, but please contact your customer success representative to find out more on this roadmap item.
API Capabilities
The API currently supports the following functionalities:
- Read security cases: Retrieve details of security cases.
- Update security cases: Include comments and update status.
- Read device information: Access information on all registered devices.
- Read all security observations: Access detailed observations related to security incidents.
- Read all raw telemetry: Obtain raw telemetry data for deeper analysis.
- Write security observations: This feature requires approval from SenseOn.
Create an API Token
To interact with the SenseOn Connect on your platform, you will need to create an access token. Navigate to Settings
> Integrations
> API Configuration
.
On this page, you can view all tokens that have been created (including those that have been deleted), who created the token, their permissions, status, and last usage.
To create a new token, press the Create token
button, and a popup will guide you through the process.
Once displayed, the token cannot be accessed again. If lost, a new token will need to be created.
Test the API
Next, you can access the live documentation and test out the API token with real data on your system. Click on Read the documentation
.
The documentation is protected with HTTP basic auth. To access it, enter any username and use the API token you generated as the password.
Authorise your API key with the documentation website by clicking Authorise
.
Then enter your token in the Personal Access Token field and select Authorise
.
Each API feature can be explored in detail. By pressing Try it out
and then Execute
, you can submit real queries to the API and receive real responses. A cURL output is provided to facilitate easier integration with other tools.
Creating Observations
Observations can be created using the API, but this action requires prior approval from SenseOn. The review process will assess:
- The impact on any managed services.
- How the data will correlate with other observations.
- The volume of observations expected.
Contact the SenseOn support team to initiate this review process.