EAeagleeyenetworks
Switches

GET /switches/{switchId}

Changed on

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

Request

  • Base URL
    https://api.cxxx.eagleeyenetworks.com/api/v3.0
  • URL
    https://api.cxxx.eagleeyenetworks.com/api/v3.0/switches/{switchId}
  • Auth
    HTTP bearer

Query parameters

includestring[]

Response

OK

idstring uuid required

Unique switch identifier

accountIdstring required

Account ID.

namestring required

Switch name

bridgeIdstring

The bridge a switch is connected to.

portCountinteger
notesstring
visibleByBridgesBridgeId2[]

Example response

{
  "id": "25c72162-cfe0-57d1-a94a-ac43904ed01a",
  "accountId": "00001106",
  "name": "EEN 4 Port PoE",
  "bridgeId": "1000f60d",
  "portCount": 4,
  "statusV2": {
    "cloudConnectionStatus": "connected",
    "edgeReportedDeviceStatus": "operational",
    "deviceSpecificError": "generalDeviceError"
  },
  "notes": "Switch with label \"SW001\"",
  "ports": [
    {
      "id": 11,
      "power": 9.8,
      "detectedDeviceCount": 4,
      "devices": [
        {
          "macAddress": "8A:D4:AD:09:DF:91",
          "ipAddress": "10.143.55.140",
          "esn": "100052842",
          "deviceName": "CAM 1",
          "deviceId": "100052842"
        }
      ]
    }
  ],
  "networkInfo": {
    "globalIP": "10.143.55.140",
    "adapters": [
      {
        "macAddress": "8A:D4:AD:09:DF:91",
        "ipAddress": "10.143.55.140"
      }
    ]
  },
  "firmware": {
    "currentVersion": "v20211019_542_3022"
  },
  "visibleByBridges": [
    "1000f60d"
  ]
}

Changes

  • c57fdb07bd73Revision changes
    • breaking

      removed the enum value data from the query request parameter include

    • breaking

      removed the enum value description from the query request parameter include

    • breaking

      removed the enum value ipAddressLocation from the query request parameter include

    • breaking

      removed the enum value userAgent from the query request parameter include

    • breaking

      for the query request parameter include, the type changed from string to array