Getting Started
API to accomplish fundamental onboarding tasks such as creating, modifying, or removing groups and assigning sensors, agents, networks, and service tests to the groups.
One common challenge for a large sensor deployment is that the individuals installing the sensors at remote sites are not the same as those using the dashboard. This can lead to misconfigurations, incorrect group assignments, and inefficiencies in the setup process. To streamline sensor onboarding, we’ve developed the UXI Onboarding API, allowing the programmatic ability to accomplish fundamental onboarding tasks such as creating, modifying, or removing groups and assigning sensors, agents, networks, and service tests to the groups.
Onboarding API Prerequisites
As a prerequisite to using the onboarding API, the following conditions must be met:
- Your dashboard must be on the HPE Greenlake Cloud Platform (GLP). If you are not yet migrated to the platform, you can follow these steps to migrate via support.
- Your dashboard must be using the new group-based configuration. We are beginning to migrate our customers to the new group-based configuration automatically beginning in February, but it may take a few months to complete for all dashboards. You can expedite the migration by following the steps to prepare your dashboard for group-based configuration.
Related Resources
API Documentation
- API Reference Guide - Browse API endpoints, request parameters, and make API calls directly
- Generating & Managing Access Tokens - Learn how to authenticate API requests
- Making API Calls - Step-by-step guide on how to make API calls to UXI
Automation SDKs & Collections
- Postman Collection - Pre-configured API requests for quick testing
- pyhpeuxi (Python SDK)
- Terraform provider for UXI
Example Scripts
Updated about 2 months ago