Project

A project is a repository designed to centralize all the data & management for a given platform.

Edge keys

Devices that communicate with the service must identify themselves. An Edge key, a special type of API key, grant write access to ingress data on the platform, as well as to query limited information (eg, checking for updates)

A project can have one or more edge keys, and it's recommended to rotate them periodically.

You can issue new edge keys or view current ones under: Project -> Project Settings -> Edge API Keys.

API keys

HexDroid CLI requires authentication, API keys are special tokens which grant write&read information into your HexDroid project,

A project can have one or more API keys, and it's recommended to rotate them periodically.

You can issue new API keys or view current ones under: Project -> Project Settings -> API Keys.

Property Management

Uploaded metrics and reports may contain various properties, which provide additional context about an event - such as the current software version or device identifiers.

HexDroid does not impose predefined meanings on specific properties; instead, it gives you full control over how they are interpreted.

However, to enable automatic data association, such as linking data to a specific device or software version, HexDroid needs to understand the meaning of certain key properties.

For example, if you have set device.serial in the metrics SDK or via the hexd daemon to represent the unique identifier of the reporting device, you must explicitly associate it with the correct meaning in HexDroid.

To do this, navigate to Project Settings → Property Settings and set Device ID to device.serial. This ensures HexDroid correctly links the property key and value to the corresponding device.

Users

Each project has its own set of permissions, and list of users that can view/contribute/manage project.

Users are divided into 3 types:

Role	Description
Visitor	Visitor role is limited in scope to only read information within the project. Visitors can't not view project API keys, or invite other users to the project.
Member	Read & Write access to most of the project
Manager	Additional permissions around project deletion, billing.