/switches

get https://{BaseUrl}/api/v3.0/switches

This endpoint allows users to retrieve a paginated list of switches within a given account.
It is important to note that after using the pageSize parameter, the "totalSize" in the response represents the total number of available switches, not the number of switches resulting from the query string.

Query Params

id__in

array of strings

List of IDs to filter on that is comma separated.

id__in

name__contains

string

Filter to get the switches whose the name contains the provided substring. The lookup is exact and case insensitive

id__contains

string

Filter to get the switches whose the id contains the provided substring. The lookup is exact and case insensitive

include

array of strings

include

pageToken

string

Token string value that references a page for pagination. This value is received when retrieving the first page in the nextPageToken and prevPageToken fields.

pageSize

integer

1 to 500

Defaults to 100

The number of entries to return per page. The maximum range of valid page sizes is documented with minimum and maximum values, but the range might be further limited dynamically based on the requested information, account, and system status. Values outside of the (dynamic) allowed range will not result in an error, but will be clamped to the nearest limit. Thus, logic to detect the last page should not be based on comparing the requested size with the received size, but on the existence of a nextPageToken value.

Responses

Response body

object

nextPageToken

string | null

required

Token to retrieve the next page. The value of this token is passed into the field pageToken. This value can be null if there is no next page.

prevPageToken

string | null

required

Token to retrieve the previous page. The value of this token is passed into the field pageToken. This value can be null of there is no previous page.

results

array of objects

required

The result set from a collection API call.

results*

object

uuid

required

Unique switch identifier

accountId

string

required

Account ID.

name

string

required

Switch name

bridgeId

string

The bridge a switch is connected to.

portCount

integer

status

object

Indicates various aspects of the device's status. The statuses defined here should be in sync with the events schema defined for the Device Cloud Status Update.

notes

string

ports

array of objects

List of ports of the switch and details about each port and what is possibly connected to it.

ports

object

integer

Port identifier, unique for the given switch

enabled

boolean

Indicates whether the port is on (true) or off (false)

power

number

Power in Watts that this port is drawing

detectedDeviceCount

integer

Number of devices connected to the port. If a single device has been detected, the Mac address and possibly the IP Address are returned.

devices

array of objects

List of devices that are known to be connected to the port.

devices

object

macAddress

string

MAC address behind the port.

ipAddress

string

IP Address found using ARP for the given MAC address.

guid

uuid

GUID of the device that corresponds to the MAC or IP connected to the port.

esn

string

Esn of the device that corresponds to the MAC or IP connected to the port.

deviceName

string | null

Name of the device that corresponds to the MAC or IP connected to the port. The value is null if no device is connected to the port.

deviceId

string | null

Id of the device that corresponds to the MAC or IP connected to the port. The value is null if no device is connected to the port.

deviceType

string | null

Type of the device that corresponds to the MAC or IP connected to the port. The value is null if no device is connected to the port. new devices might be added in the future.

camera speaker bridge multiCamera

networkInfo

object

firmware

object

visibleByBridges

array of strings

visibleByBridges

totalSize

integer

required

Size of the total result set.

Language

Credentials

Bearer

JWT

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://api.cxxx.eagleeyenetworks.com/api/v3.0/switches?pageSize=100' \
3
     --header 'accept: application/json'

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

application/json

200OK

400The supplied object is invalid. Error detail will contain the validation error.

401You are not authenticated. Please authenticate and try again.

404Referenced resource could not be found.

500Something went wrong in the server. Please try again.