Introduction

The Eagle Eye Networks bridge connects the physical devices to the Eagle Eye Networks Cloud. The bridge makes cameras and speakers discoverable in the network so that they can be added to the account. The bridge also manages the video being streamed to the cloud.

The guide describes how to add a bridge to an account, and manage it.

Procedure

Adding a bridge to your account

1. Log in to your account.
2. Add the bridge to the account.

📘

Note

The bridge is supplied with a unique connect ID which helps Eagle Eye Networks identify the device. Adding a bridge to the account can be done using API by providing this connect ID along with a name for the bridge using the POST bridges request.

The following is an example for adding a bridge to the account

https://{baseUrl}/api/v3.0/bridges

curl --request POST \
     --url https://<baseURL>/api/v3.0/bridges \
     --header 'Accept: application/json' \
     --header 'Content-Type: application/json' \
     --header 'Authorization: Bearer <access_token>'\
     --data '
{
     "name": "CF1 EBT Bridge",
     "connectId": "1ABC-1234-A12B-1AB4"
}

Result: The bridge is added to the account and a bridgeId is created.

Viewing bridges in the account

• Viewing bridges on the account can done using the GET /bridges endpoint.

📘

Note

You do not need any parameters for this. If you need additional details (status, timezones, etc) they can be requested using the include parameter.

curl -X 'GET' \
  'https://<baseURL>/api/v3.0/bridges?include=timeZone&pageSize=100' \
  --header 'accept: application/json'\
  --header 'Authorization: Bearer <access_token>'\

• To access the information of a single bridge, provide the bridgeId to the GET /bridges endpoint.

In the following example, bridgeId is 'abcd123' and status of the bridge is also requested:

curl -X 'GET' \
  'https://<baseURL>/api/v3.0/bridges/abcd123?include=status' \
  --header 'accept: application/json'\
  --header 'Authorization: Bearer <access_token>'\

Updating bridge information

1. Update bridge information can be with a PATCH request.

For example:

curl -X 'PATCH' \
  'https://<baseURL>/api/v3.0/bridges/abcd123' \
  --header 'accept: */*' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <access_token>'
  -d '{
  "name": "CF1 EBT Bridge",
  "notes": "Previously used for laser eye surgery. Records pizzas as squares",
  "locationId": "2428fda3-389f-48ce-b062-85875dd6b2e2"
}'

Removing a bridge from the account

🚧

Important

The bridge can only be deleted after all devices associated with the bridge are removed.

1. Make sure to remove all associated devices.
2. Use the DELETE /bridges/{bridgeId} API endpoint to remove a bridge from the account.

The following is an example for a DELETE request:

curl -X 'DELETE' \
  'https://<baseURL>/api/v3.0/bridges/abcd123' \
  --header 'accept: */*'\
  --header 'Authorization: Bearer <access_token>'\