v1

latestOpenAPI 3.0.02026-07-243339471.1 MB
Location

List devices with location information

This API endpoint retrieves a list of network devices that have been assigned location information (e.g. after being placed on a floorplan and/or automatically determined by the system). Each device in the returned list includes details like serial number, MAC address, IP address, consolidated location, etc. The consolidated location of a device is the best known location of the device (x/y coordinates on the floorplan and/or latitude/longitude geographic coordinates) with the administrator-specified position always taking precedence. The query parameters allow you to narrow down the results to devices that meet specific criteria, ensuring you receive only the relevant data. Device lists are restricted to a single site represented by the required site-id query parameter.

get/network-services/v1/sites/{site-id}/device-locations

Path parameters

site-idstring uuid required

Site ID associated with the device commonly in UUID format.

The ID of the Site for which device location information is requested.

Query parameters

filterstring const

OData Version 4.0 filter string (limited functionality). Supports only 'eq' operations ('gt', 'ge', 'lt', 'le' and 'in' are NOT supported). Supports only 'and' conjunction ('or' and 'not' are NOT supported). Supported filter fields are: floorId and buildingId.

OData 4.0 filter (limited functionality). Supports only 'and' conjunction ('or' and 'not' are NOT supported). Supports filtering on fields floorId and buildingId only.

limitinteger

Denotes the maximum number of devices returned in the response. (Default: 100)

nextstring

Specifies the pagination cursor for the next page of resources.

Example:1
with-locationboolean

Filter for devices with or without location based on this parameter.

Response

Returned device list with their consolidated locations.

countinteger required

The number of objects returned in the current list (maximum will be the page size).

totalinteger required

The total number of objects contained in the datastore.

nextstring const

An opaque cursor which could be passed in the next query to fetch the next page. Set to null when no more pages remain.