Partner Integration
3 minute read
Currently, New Central offers three REST APIs pertaining to Open Locate.
NBAPI for device locations
Endpoint: GET https://example.com/network-monitoring/v1alpha1/devices/with-location?
Parameter: filter=siteId eq ‘012931’
-
This endpoint provides a list of devices with available location data, either in (x/y) coordinates or latitude/longitude or both. Use this endpoint to obtain the count of devices with longitude and latitude values for a given site.
-
The filter requires at least the siteId parameter. Additionally, you can use floorId and buildingId as supported fields for more specific filtering.
-
Using this endpoint, you can easily fetch a list of devices with precise location information, such as latitude and longitude, associated with a specific site. By specifying the site_id, you can focus on devices within a particular building or floor, streamlining your monitoring efforts and enhancing facility management.
{
"data": {
"listConsolidatedDeviceLocationsNBAPI": {
"deviceLocationSummary": {
"deviceLocations": [
{
"id": "CNXXXXXXXX",
"type": "ACCESS_POINT",
"createdAt": "2024-04-16T17:24:44.055Z",
"siteId": "791852196",
"floorId": "adbbb348-3c3f-4043-b10c-c7a01522c57f",
"buildingId": "8270en8z2xiwsljdkqlwi931ue",
"tenantId": "iwpmdowier03qrjasdklweifqiwdjw",
"ipv4": "x.x.x.x",
"ipv6": "",
"mac": "AA:BB:CC:DD:EE:FF",
"model": "AP-535",
"deployment": "Standalone",
"status": "ONLINE",
"consolidatedLocation": {
"source": "ADMIN_SPECIFIED",
"timestamp": "2024-04-24T16:35:09.087Z",
"cartesianCoordinates": {
"unit": "METERS",
"x_position": 4.133599281311035,
"y_position": 53.278629302978516
},
"center": {
"longitude": -121.98750299786495,
"latitude": 37.385833803552615
},
"lciUncertainty": null,
"altitude": null
}
}
],
"count": 1,
"total": 1,
"next": null
}
}
}
}
Retrieve data for all devices with no location on the mentioned site
Endpoint: GET https://example.com/network-monitoring/v1alpha1/devices/without-location?
Parameter: filter=siteId eq ‘012931’
-
Utilize this endpoint to retrieve a list of devices lacking location data for a specified site.
-
The filter requires at least the siteId parameter. Additionally, you can use floorId and buildingId as supported fields for more specific filtering.
-
This endpoint is particularly useful for users troubleshooting issues related to devices without location information on a given site.
{
"data": {
"listConsolidatedDeviceLocationsNBAPI": {
"deviceLocationSummary": {
"deviceLocations": [
{
"id": "CNXXXXXXX",
"type": "GATEWAY",
"createdAt": "2024-04-19T20:27:53.566Z",
"siteId": "791852196",
"floorId": null,
"buildingId": null,
"tenantId": "416bc832bc6111ed961e6aa14dbf31f1",
"ipv4": "172.30.32.21",
"ipv6": "",
"mac": "AA:BB:CC:DD:EE:FF",
"model": "A7008",
"deployment": "Cluster",
"status": "ONLINE",
"consolidatedLocation": null
}
],
"count": 1,
"total": 1,
"next": null
}
}
}
}
Retrieve data for a particular device using serial number
Endpoint: GET https://cnx-apigw-internal2.central.arubanetworks.com/network-monitoring/v1alpha1/devices/<SERIAL>/location?siteId=<siteId>
-
Utilize this endpoint to retrieve data for a particular device.
-
This endpoint is particularly useful for users troubleshooting issues related to devices without location information on a given site.
{
"data": {
"getDeviceLocationDetails": {
"id": "CNXXXXXXX",
"type": "ACCESS_POINT",
"createdAt": "2024-04-28T16:06:15.403Z",
"siteId": "791852196",
"floorId": "adbbb348-3c3f-4043-b10c-c7a01522c57f",
"buildingId": "7695ba72-8663-474d-8979-bb567e9cf83d",
"tenantId": "416bc832bc6111ed961e6aa14dbf31f1",
"ipv4": "10.1.1.1",
"ipv6": "",
"mac": "AA:BB:CC:DD:EE:FF",
"model": "AP-635",
"deployment": "Standalone",
"status": "ONLINE",
"gpsLocation": null,
"autoPlacedLocation": null,
"adminSpecifiedLocation": {
"source": "ADMIN_SPECIFIED",
"timestamp": "2024-04-24T16:35:09.087Z",
"cartesianCoordinates": {
"unit": "METERS",
"x_position": 4.133599281311035,
"y_position": 53.278629302978516
},
"center": {
"longitude": -121.98750299786495,
"latitude": 37.385833803552615
},
"lciUncertainty": null,
"altitude": null
},
"consolidatedLocation": {
"source": "ADMIN_SPECIFIED",
"timestamp": "2024-04-24T16:35:09.087Z",
"cartesianCoordinates": {
"unit": "METERS",
"x_position": 4.133599281311035,
"y_position": 53.278629302978516
},
"center": {
"longitude": -121.98750299786495,
"latitude": 37.385833803552615
},
"lciUncertainty": null,
"altitude": null
}
}
}
}
Feedback
Was this page helpful?
Glad to hear it!
Sorry to hear that.