Authorization

Generate Access Tokenpost

Monitoring

Access Points
Application Visibility
- Get applications accessed in a siteget
Location Services
- Get locations of Wi-Fi clientsget
Device Location
Devices
- Get a list of devicesget
- Get a device inventory listget
Firewall Session
FloorPlan
Open Locate
Switch
Gateway Monitoring
- Get a list of Gatewaysget
- The API provides detailed information of a Gatewayget

Authorization

Generate Access Tokenpost

Monitoring

Access Points
Application Visibility
- Get applications accessed in a siteget
Location Services
- Get locations of Wi-Fi clientsget
Device Location
Devices
- Get a list of devicesget
- Get a device inventory listget
Firewall Session
FloorPlan
Open Locate
Switch
Gateway Monitoring
- Get a list of Gatewaysget
- The API provides detailed information of a Gatewayget

Retrieves assigned devices

get https://ge1.api.central.arubanetworks.com/network-monitoring/v1alpha1/sitemaps/{site-id}/network-devices-assigned

Devices that have been assigned to the floor are returned. Devices that have been placed on the floor are not included in the result

time	status	user agent
Retrieving recent requests…

Loading…

URL Expired

The URL for this request expired after 30 days.

Path Params

site-id

string

required

length ≤ 128

Id of the site for which the map related information is requested.

Query Params

filter

string

required

length ≤ 256

OData 4.0 filter must be provided with at least floorId. Other supported fields are types (in operator must be used ), mac, serial, name

limit

int32

1 to 1000

Defaults to 1000

Specifies the number of results to be returned.

string

length ≤ 10

Specifies the pagination cursor for the next page of resources.

query-time

string

length ≤ 13

epoch timestamp to get a snapshot at particular time

Responses

Response body

object

count

int32

required

1 to 2147483647

The number of objects returned in the current list.

total

int64

required

0 to 9223372036854776000

The total number of objects contained in the datastore.

string

required

length ≤ 128

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

response

object

required

code

string

required

length ≤ 32

status code.

status

string

required

length ≤ 20

Final status of operation.

message

string

required

length ≤ 512

Descriptive text on the outcome of the operation.

items

array of objects

required

length ≤ 9999

items*

object

serial

string

length ≤ 16

Device serial number.

model

string

length ≤ 32

mac

string

length ≤ 18

name

string

required

length ≤ 128

device name

partNumber

string

length ≤ 12

device part number

ipAddress

string

length ≤ 15

state

string

length ≤ 32

string

required

length ≤ 16

Device serial number.

type

string

required

Access Point Switch Gateway

Headers

object

X-RateLimit-Limit

int64

0 to 9223372036854776000

Request limit per hour.

X-RateLimit-Remaining

int64

0 to 9223372036854776000

The number of requests left for the time window.

X-RateLimit-Reset

date-time

length ≤ 20

The UTC date/time at which the current rate limit window resets.

Response body

object

errorCode

string

required

length ≤ 128

Internal error code.

HPE_GL_NETWORK_MONITORING_RFGRAPH_INVALID_INPUT

message

string

required

length ≤ 512

Error message indicating the cause of the failure.

debugId

string

required

length ≤ 128

Internal debug id.

httpStatusCode

integer

required

400 to 400

HTTP status code.

Headers

object

X-RateLimit-Limit

int64

0 to 9223372036854776000

Request limit per hour.

X-RateLimit-Remaining

int64

0 to 9223372036854776000

The number of requests left for the time window.

X-RateLimit-Reset

date-time

length ≤ 20

The UTC date/time at which the current rate limit window resets.

Response body

object

errorCode

string

required

length ≤ 32

Internal error code.

HPE_GL_NETWORK_MONITORING_RFGRAPH_INVALID_SESSION

message

string

required

length ≤ 512

Error message indicating the cause of the failure.

debugId

string

required

length ≤ 128

Internal debug id.

httpStatusCode

integer

required

401 to 401

HTTP status code.

Headers

object

X-RateLimit-Limit

int64

0 to 9223372036854776000

Request limit per hour.

X-RateLimit-Remaining

int64

0 to 9223372036854776000

The number of requests left for the time window.

X-RateLimit-Reset

date-time

length ≤ 20

The UTC date/time at which the current rate limit window resets.

Response body

object

errorCode

string

required

length ≤ 32

Internal error code.

HPE_GL_ERROR_FORBIDDEN

message

string

required

length ≤ 512

Forbidden.

debugId

string

required

length ≤ 128

Internal debug id.

httpStatusCode

integer

required

403 to 403

HTTP status code.

Headers

object

X-RateLimit-Limit

int64

0 to 9223372036854776000

Request limit per hour.

X-RateLimit-Remaining

int64

0 to 9223372036854776000

The number of requests left for the time window.

X-RateLimit-Reset

date-time

length ≤ 20

The UTC date/time at which the current rate limit window resets.

Response body

object

httpStatusCode

integer

required

404 to 404

HTTP status code.

errorCode

string

required

length ≤ 32

Internal error code.

message

string

required

length ≤ 512

Not Found.

debugId

string

required

length ≤ 50

This can be used to help with troubleshooting

Headers

object

X-RateLimit-Limit

int64

0 to 9223372036854776000

Request limit per hour.

X-RateLimit-Remaining

int64

0 to 9223372036854776000

The number of requests left for the time window.

X-RateLimit-Reset

date-time

length ≤ 20

The UTC date/time at which the current rate limit window resets.

Response body

object

errorCode

string

required

length ≤ 128

Internal error code.

HPE_GL_ERROR_TOO_MANY_REQUESTS

message

string

required

length ≤ 512

Error message indicating the cause of the failure.

debugId

string

required

length ≤ 128

Internal debug id.

httpStatusCode

integer

required

429 to 429

HTTP status code.

Headers

object

X-RateLimit-Limit

int64

0 to 9223372036854776000

Request limit per hour.

X-RateLimit-Remaining

int64

0 to 9223372036854776000

The number of requests left for the time window.

X-RateLimit-Reset

date-time

length ≤ 20

The UTC date/time at which the current rate limit window resets.

Response body

object

errorCode

string

required

length ≤ 32

Internal error code.

HPE_GL_NETWORK_MONITORING_RFGRAPH_DATABASE_ERROR HPE_GL_NETWORK_MONITORING_RFGRAPH_ERROR

message

string

required

length ≤ 512

Error message indicating the cause of the failure.

debugId

string

required

length ≤ 128

Internal debug id.

httpStatusCode

integer

required

500 to 500

HTTP status code.

Headers

object

X-RateLimit-Limit

int64

0 to 9223372036854776000

Request limit per hour.

X-RateLimit-Remaining

int64

0 to 9223372036854776000

The number of requests left for the time window.

X-RateLimit-Reset

date-time

length ≤ 20

The UTC date/time at which the current rate limit window resets.

Updated about 2 months ago

Assign/Unassign devices to the FloorPlan

Place planned devices

Did this page help you?

Language

Credentials

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://ge1.api.central.arubanetworks.com/network-monitoring/v1alpha1/sitemaps/site-id/network-devices-assigned \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Updated about 2 months ago

Assign/Unassign devices to the FloorPlan

Place planned devices

Did this page help you?

Authorization
Generate Access Tokenpost

Monitoring
Access Points
Get an Access Point detailsget
Get a list of Access Pointsget
Get high wireless bandwidth usage Access Pointsget
Application Visibility
Get applications accessed in a siteget
Location Services
Get locations of Wi-Fi clientsget
Device Location
Delete device coordinatesdelete
Set device coordinatespost
Get device location detailsget
Get location resourceget
List devices with location informationget
Devices
Get a device inventory listget
Get a list of devicesget
Firewall Session
Get clients listget
Get client firewall session logsget
Get blocked firewall session logsget
FloorPlan
Retrieve channel occupancy heatmap.get
Retrieve signal strength heatmap.get
Delete zonesdelete
Update zonesput
Create zonepost
Retrieves Zonesget
Delete Walls.delete
Update Walls.put
Create Wallpost
Retrieve Wallsget
Delete Wall Types.delete
Update Wall Typesput
Create Wall Typespost
Retrieve Wall Typesget
Retrieve Import Statusget
Import FloorPlans using zip filepost
Update Buildingput
Remove Buildingdelete
Retrieve building informationget
Get RasterImageget
Get floor background Image detailsget
Update Floor Imageput
Scale FloorMappost
Update FloorMapput
Retrieve FloorMap informationget
Remove floor from a buildingdelete
Create New Floorpost
Retrieves All Real device informationget
Remove planned devices on the FloorPlandelete
Retrieves placed (planned) devicesget
Place planned devicespost
Retrieves assigned devicesget
Assign/Unassign devices to the FloorPlanpost
Remove devices from the FloorPlanpost
Retrieves placed devices over the FloorPlanget
Place devices over the FloorPlanpost
Site devices summaryget
Open Locate
Stop an FTM scandelete
Get FTM scan resourceget
List FTM scansget
Start an FTM scan (USE WITH CAUTION)post
Switch
Returns lag summary details for the given serial.get
Returns hardware details for the given serial.get
Returns stack member details for the given stack-id.get
Returns switch details for the given serial.get
Gateway Monitoring
The API provides detailed information of a Gatewayget
Get a list of Gatewaysget

Authorization
Generate Access Tokenpost

Monitoring
Access Points
Get an Access Point detailsget
Get a list of Access Pointsget
Get high wireless bandwidth usage Access Pointsget
Application Visibility
Get applications accessed in a siteget
Location Services
Get locations of Wi-Fi clientsget
Device Location
Delete device coordinatesdelete
Set device coordinatespost
Get device location detailsget
Get location resourceget
List devices with location informationget
Devices
Get a device inventory listget
Get a list of devicesget
Firewall Session
Get clients listget
Get client firewall session logsget
Get blocked firewall session logsget
FloorPlan
Retrieve channel occupancy heatmap.get
Retrieve signal strength heatmap.get
Delete zonesdelete
Update zonesput
Create zonepost
Retrieves Zonesget
Delete Walls.delete
Update Walls.put
Create Wallpost
Retrieve Wallsget
Delete Wall Types.delete
Update Wall Typesput
Create Wall Typespost
Retrieve Wall Typesget
Retrieve Import Statusget
Import FloorPlans using zip filepost
Update Buildingput
Remove Buildingdelete
Retrieve building informationget
Get RasterImageget
Get floor background Image detailsget
Update Floor Imageput
Scale FloorMappost
Update FloorMapput
Retrieve FloorMap informationget
Remove floor from a buildingdelete
Create New Floorpost
Retrieves All Real device informationget
Remove planned devices on the FloorPlandelete
Retrieves placed (planned) devicesget
Place planned devicespost
Retrieves assigned devicesget
Assign/Unassign devices to the FloorPlanpost
Remove devices from the FloorPlanpost
Retrieves placed devices over the FloorPlanget
Place devices over the FloorPlanpost
Site devices summaryget
Open Locate
Stop an FTM scandelete
Get FTM scan resourceget
List FTM scansget
Start an FTM scan (USE WITH CAUTION)post
Switch
Returns lag summary details for the given serial.get
Returns hardware details for the given serial.get
Returns stack member details for the given stack-id.get
Returns switch details for the given serial.get
Gateway Monitoring
The API provides detailed information of a Gatewayget
Get a list of Gatewaysget

200Returns assigned devices for the floor.

400Invalid input received.

401Unauthorized request.

403Forbidden: Access is denied.

404Not Found error

429Too Many Requests. Rate limit exceeded.

500Internal Server Error.