Overview
Ensemble offers a public API for programmatic access to some of the MDM features. Using this API allows these features to be incorporated into other applications.
Click here to view the API documentation.
Before using the API, a secret API Key needs to be created. This should stay private and not shared with unauthorized parties.
Sending this API Key with each request will allow access to the API. For more details on how to use this API Key, please read the API documentation.
Creating The API Key
- Log in to the Ensemble Portal.
- Using the sidebar navigation, go to Settings > API.
- Create an API Key. NOTE: There is a limit of 1 active API key at a time.
Revoking An API Key
Because an API Key is uniquely associated with an Ensemble account and can be used to access sensitive device & customer information, it is important that the API Key stays secured.
If unauthorized access of the API Key is suspected or confirmed, immediately revoke it.
- Log in to the Ensemble Portal.
- Using the sidebar navigation, go to Account Settings > API Access.
- Revoke the currently active API Key.
- Create a new API Key.
IMPORTANT: Any API requests made with the revoked API key will fail until the requests are updated to use the newly created API Key.
