/switches/{switchId}

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

This endpoint allows users to retrieve a specific switch based on its id.

Responses

Response body

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.

connectionStatus

string

Indicates the connection status of the device:

online: The device is online and operational.
deviceOffline: The device is offline.
invalidCredentials: The known credentials for this device, including the default credentials, are invalid. This is causing the device to appear offline.
bridgeOffline: The bridge that connects this device to the cloud is offline. However, both the device and the bridge may still be operational locally, even though the cloud has no visibility into their status.
off: The device is online, but has been turned off by the user.
error: The device is offline due to some problem that has not been described by any of the other statuses.
unknown: The device state is unknown for some reason.

online deviceOffline invalidCredentials bridgeOffline off error unknown

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

globalIP

string | null

adapters

array of objects

adapters

object

macAddress

string | null

ipAddress

string | null

firmware

object

currentVersion

string | null

visibleByBridges

array of strings

visibleByBridges

Language

Credentials

Bearer

JWT

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api.cxxx.eagleeyenetworks.com/api/v3.0/switches/switchId \
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.

403You have no permission to access the specified resource.

404Referenced resource could not be found.

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