EAeagleeyenetworks
Available Devices

GET /availableDevices

Changed on

This endpoint returns a list of all devices found by the bridges in the account that have not yet been added. Devices of a certain type will not be reported in the response if the user does not have permission to add them. Since adding specific device types requires calling a device-type-specific API, it is recommended to filter on the devices supported by the cameras, rather than retrieving "all" types. It is important to note that after using the pageSize parameter, the "totalSize" in the response represents the total number of available devices, not the number of devices resulting from the query string.

Request

  • Base URL
    https://api.cxxx.eagleeyenetworks.com/api/v3.0
  • URL
    https://api.cxxx.eagleeyenetworks.com/api/v3.0/availableDevices
  • Auth
    HTTP bearer

Query parameters

deviceType__instring[] required

List of device types that are supported by the client. Required as new device types might be added at any time, which might need client (parser) changes before they are supported.

state__instring[]

List of different device states. If provided, the response will only contain devices with provided states.

bridgeId__instring[]

Filter to get the available devices whose bridge id is on the provided list. The lookup is exact and case insensitive

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.

includestring[]

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": [
    {
      "guid": "ddfa5b34-5d04-431e-8287-110fe87edf71",
      "visibleByBridges": [
        "1000f60d"
      ],
      "firmwareVersion": "v20211019_542_3022",
      "ipAddress": "10.143.55.140",
      "otherIpAddress": [
        "10.143.55.140"
      ],
      "visibleByBridgesDetailed": [
        {
          "id": "1000f60d",
          "name": "Bridge Name"
        }
      ]
    }
  ]
}

Changes

  • c57fdb07bd73Revision changes
    • breaking

      removed the enum value accountId from the property items/ of the query request parameter include

    • breaking

      removed the enum value createTimestamp from the property items/ of the query request parameter include

    • breaking

      removed the enum value details from the property items/ of the query request parameter include

    • breaking

      removed the enum value failure from the property items/ of the query request parameter state__in

    • breaking

      removed the enum value md5 from the property items/ of the query request parameter include

    • breaking

      removed the enum value metadata from the property items/ of the query request parameter include

    • breaking

      removed the enum value notes from the property items/ of the query request parameter include

    • breaking

      removed the enum value pending from the property items/ of the query request parameter state__in

    • breaking

      removed the enum value revoked from the property items/ of the query request parameter state__in

    • breaking

      removed the enum value size from the property items/ of the query request parameter include

    • breaking

      removed the enum value started from the property items/ of the query request parameter state__in

    • breaking

      removed the enum value storageId from the property items/ of the query request parameter include

    • breaking

      removed the enum value success from the property items/ of the query request parameter state__in

    • breaking

      removed the enum value tags from the property items/ of the query request parameter include

    • breaking

      removed the enum value updateTimestamp from the property items/ of the query request parameter include

    • breaking

      removed the enum value uploadUrl from the property items/ of the query request parameter include

    • warning

      for the query request parameter state__in, the type of property items/ changed from no type to string

    • info

      added the enum value addable to the property items/ of the query request parameter state__in

    • info

      added the enum value inOtherAccount to the property items/ of the query request parameter state__in

    • info

      added the enum value notSupported to the property items/ of the query request parameter state__in

    • info

      added the enum value unknown to the property items/ of the query request parameter state__in

    • info

      added the enum value visibleByBridgesDetailed to the property items/ of the query request parameter include