One common challenge for a large UXI 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 and agent 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.

Please note that the UXI Onboarding API covers the essential onboarding actions you typically undertake within the UXI application itself. Actions that you perform in the Greenlake Cloud Platform, such as adding devices (UXI hardware sensors) to your Greenlake Cloud Platform device inventory and associating sensors with the User Experience Insight application and UXI subscirptions, would need to be accomplished through the Greenlake Cloud Platform API. https://developer.greenlake.hpe.com/

In addition, you may also want to integrate UXI with your ticketing tools but don’t have the ability to take advantage of the UXI data push destinations feature. Now you can use the sensor status API to determine whether a sensor is online, testing and get a list all the ongoing issues detected by the sensor or agent. Note that even if a sensor is muted, muting only affects the visual representation in the dashboard and email/webhook alerts. Mutes do not affect the data push issues or ongoing issues returned by the status API.

Onboarding and Status API Prerequisites

As a prerequisite to using the onboarding APIs and status API, 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.

API Documentation

You can download the API documentation here https://api.capenetworks.com/docs/openapi.yaml

The documentation follows OpenAPI specification 3.1.0 and can be viewed using tools like Swagger UI. Note that this download link may change in the future. You may need to refer to this page to get the updated link.

You can also view the API documentation in your browser on the developer hub.

API Rate Limit

The rate limit of the UXI Onboarding API is 5 requests per second per customer.

Generate an API Key

To get started with the UXI Onboarding API and Status API, first go to your Greenlake Cloud Workspace and select Manage Workspace.

Next, select the option for Personal API clients and select Create Personal API Client.

In the pop-up menu, provide a personal API client name and select the service for User Experience Insight (US West). Then select Create Personal API client.

You will then be given a Client ID and Client secret. Store these values locally in a safe location.

When you look at the page for personal API clients again, you will see the one you created. Expand the menu to generate an access token using the client secret or view the code sample to see how to generate the access token using the client secret.

Once you have the token, here is a basic example of an HTTP GET to get sensor properties using the API:

curl --location 'https://api.capenetworks.com/networking-uxi/v1alpha1/sensors' \
--header 'Authorization: Bearer <insert token>'

If all goes well, you should get a response with the list of sensors and the sensor properties. For example:

{
    "items": [
        {
            "id": "34c5e3ee-3bd7-4b22-a3bc-ec5a129f0129",
            "serial": "VNS9LPM0LJ",
            "name": "VNS9LPM0LJ",
            "modelNumber": "UX-G6EC",
            "wifiMacAddress": "f0:1a:a0:71:a9:8f",
            "ethernetMacAddress": "f0:1a:a0:71:a9:8e",
            "addressNote": "",
            "longitude": NN.NNNN,
            "latitude": NN.NNNN,
            "notes": "",
            "pcapMode": "light",
            "type": "networking-uxi/sensor"
        }
    ],
    "count": 1,
    "next": null
}

Note that the UXI Onboarding API uses curser-based pagination.

To use the status API, use the sensor id in the output above in the URL and make a request

curl --location ' https://api.capenetworks.com/networking-uxi/v1alpha1/sensors/{sensor id}/status ' \ 
--header 'Authorization: Bearer <insert token>'

If all goes well, you should get a response with whether the sensor is online, testing and a list of any issues that are in the ongoing state.

A sensor that is online and testing with no issues may give a response with:

{
   "isTesting":true,
   "isOnline":true,
   "issues":[
   ]
}

A sensor that is online and testing with ongoing issues detected may give a response with:

{
   "isTesting":true,
   "isOnline":true,
   "issues":[
      {
         "code":"EXTERNAL_SSL_ERROR",
         "context":{
            "customerId":"1108a0d2-91d5-4b0d-81e2-25a2f3797a71",
            "groupName":"San Francisco",
            "groupPath":"25a2f3797a71.b942b9d4b31d.87cc9b3e461d",
            "interfaceType":"wifi",
            "macAddress":"20:4c:03:50:7b:a3",
            "networkName":"uxi_psk_6ghz",
            "networkId":"ssid-8fa73fec42cb",
            "sensorName":"CNHJKLQ2MH",
            "sensorSerial":"CNHJKLQ2MH",
            "sensorId":"756a9f53-1c7c-4ed4-bc20-ae076b88820a",
            "serviceTestName":"Bad SSL Cert Test",
            "serviceTestId":"ea1f4f7c-069b-45d0-b768-117d04bd941b"
         },
         "incidentId":null,
         "severity":"ERROR",
         "status":"CONFIRMED",
         "timestamp":"2026-02-05T00:21:50.679626+00:00",
         "id":"0b8fbd7e-9189-407b-835d-e166dc9b9c94"
      }
   ]
}

Notes:

A sensor will have the status "isOnline":false only when the sensor has not reported in the last 90 minutes.
- You may run into cases where you have a power outage issue, but the status still says "isOnline":true. This is expected because the sensor has reported in the last 90 minutes. Therefore, you also need to look at the issues to determine whether a power outage has occurred.
The "isTesting":true field means that the sensor is configured and assigned to a group that has networks assigned to it, and is also reporting that it is online.
The issue uid is a unique identifier for a specific issue.
Timestamp is the time the issue was last confirmed, not the time the issue was first detected.
Even if a sensor is muted, muting only affects the visual representation in the dashboard and email/webhook alerts. Mutes do not affect the data push issues or ongoing issues returned by the status API.
If you want to get the status of an agent, you must also use the API /networking-uxi/v1alpha1/sensors/{sensor id}/status

Using the UXI Onboarding API with Terraform

UXI is in the process of developing a terraform provider for the onboarding API. For early access to the Terraform provider, you can contact support. Please note that you must migrate to the official provider once it is released, as the early access will be deprecated 3 months after the official release is made.

Examples of using the APIs

We have created a few basic examples of using the onboarding API