In EchoVideo, the Epiphan device key is a unique identifier that links an Epiphan appliance (such as a Pearl Mini, Pearl Nano, or Pearl-2) to its corresponding device record in EchoVideo. It establishes the trust relationship between the physical encoder and the EchoVideo platform, enabling the device to authenticate and upload content.

The Device Keys tab on the Epiphan Device Configuration page allows administrators to generate new device keys, monitor their usage, and remove keys that are no longer needed.

What Is the Device Key Used For?

The device key is used to:

• Authenticate the Epiphan device with EchoVideo.
• Associate recordings and live streams with the correct EchoVideo device.
• Allow the device to automatically upload recordings and metadata to EchoVideo.
• Ensure that only an authorized device can communicate with the associated EchoVideo account.

In practice, once the key is configured on the Epiphan device, uploads and other integrations occur automatically without requiring a user to log in each time.

Access the Device Keys

1. Log in as an administrator.

2. Navigate to Settings > Configuration > Epiphan Devices.

   The Device Keys tab is selected by default.

The page contains the following sections:

• Connect Your Epiphan Device - Generate and validate device keys for new devices.
• Existing Device Keys - View and manage all device keys in your institution.

View Existing Device Keys

The Existing Device Keys table displays all device keys created for your institution.

• Device Key Name - The descriptive name assigned to the device key.
• API Key - The unique API Key associated with the device key.
• In Use - The number of Epiphan devices currently using the device key.

Search for a device key by name in the search field and / or filter the list by campus or building to quickly locate specific device keys.

Copy an API Key

If you need to configure an additional device using an existing key, you can copy the API Key directly from the table.

1. Locate the desired device key.
2. Copy the API Key.

3. Paste the value into the Epiphan device configuration.

   Only the API Key is available after creation. The API Secret cannot be viewed again after the device key is generated.

View Devices Using a Device Key

Before modifying or deleting a device key, you can determine which devices currently use it.

1. In the In Use column, click the number associated with the device key.

2. The In Use modal opens, showing each device using the selected key, including:

   • Device serial number
   • Campus
   • Building
   • Room assignment

   

Review this information before deleting or replacing a device key to understand which devices will be affected.

Delete Device Keys

Delete a device key only when it is no longer needed or when you are replacing it with a new key. Common reasons include replacing an Epiphan device, moving a device to another EchoVideo institution, retiring a device, or generating new credentials after an existing key has been compromised.

Before deleting a device key, review the In Use count to determine whether any devices are currently using it. If the key is assigned to one or more devices, those devices will no longer be able to authenticate with EchoVideo after the key is deleted. As a result, automatic uploads and other communication with EchoVideo will stop until a new device key is generated and configured on each affected device.

Deleting a device key does not remove recordings from the Epiphan device or delete media already uploaded to EchoVideo. However, any recordings created after the key is deleted will not upload automatically until the device has been reconfigured with a valid device key.

If the device will continue to be used, ensure that a replacement device key is available before deleting the existing one. It is also recommended that you verify there are no recordings waiting to be uploaded and notify anyone responsible for managing the device that uploads will be interrupted until the new key is installed.

Deleting the device key for an active Epiphan device immediately disconnects it from EchoVideo. Any Rooms or Schedules that depend on that device may be unable to complete scheduled captures or upload recordings until a new device key is configured and the device reconnects.

To delete a device key:

1. Locate the device key in the Existing Device Keys table.
2. Click Delete.
3. In the Warning message that appears, type DELETE to confirm. 
4. Click Delete.