Sign in

v1

latestOpenAPI 3.0.32026-07-24214879985.1 KB
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.

get/switches

Query parameters

id__instring[]

List of IDs to filter on that is comma separated.

[
  "00001106",
  "00001107"
]
name__containsstring

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

id__containsstring

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

include'description' | 'userAgent' | 'data' | 'ipAddressLocation'
pageTokenstring

Token string value that references a page for pagination. This value is received when retrieving the first page in the nextPageToken and prevPageToken fields. When a pageToken is provided, the backend remembers search parameters from the original request, so search parameters that affect the result set or order are optional and will be ignored if provided. Representation parameters like include should still be applied.

pageSizeinteger

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.

Response

OK

nextPageTokenstring nullable 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.

prevPageTokenstring nullable 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.

totalSizeinteger required

Size of the total result set.

Example response

{
  "results": [
    {
      "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"
      ]
    }
  ]
}