Location

Get location resource

This API provides the location details for a specific location resource. The site-id must be provided alongside the location-id to properly fetch the location data. Each unique location-id represents a change in device location, for example if an AP was moved from one floorplan to another a new location resource with a unique location-id will be created.

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

Request

Path parameters

site-idstring uuid required

Site ID associated with the device commonly in UUID format.

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

location-idstring const required

Uniquely generated ID for a device location.

The ID of the location resource to be fetched.

Response

Returned device location resource.

idstring const required

Uniquely generated ID for a device location.

serialNumberstring const

The device serial number.

type'ACCESS_POINT' | 'SWITCH' | 'GATEWAY' required

A string indicating the networking device type.

createdAtunknown required
siteIdstring uuid required

Site ID associated with the device commonly in UUID format.

buildingIdunknown
floorIdunknown required
floorLevelunknown
tenantIdunknown
ipv4unknown
ipv6unknown
macAddressunknown
modelunknown
deploymentunknown
status'ONLINE' | 'OFFLINE'

Changes

No recorded changes to this operation across all 1 revision of this API.