The BrynQ Agent needs one key to work: a BrynQ API token that belongs to your BrynQ environment. You paste it once while you install the Agent. The Agent keeps it on the server and uses it to prove to BrynQ which customer it belongs to.
Without a valid token, the Agent cannot set up its secure connection to BrynQ and cannot update itself.
| When | What the token does |
| During installation | BrynQ checks the token and looks up the customer it belongs to. It then creates the secure connection and your Agent's own address: https://<your-customer>.brynq-agent.com. |
| Automatic updates | The Agent uses the token to check for new versions and to download them from BrynQ. |
| Connection test | The BrynQ connection page of the local admin dashboard uses the token to test whether BrynQ accepts this Agent. |
| Incoming requests | The Agent only accepts requests for your customer. Requests that name another customer are refused, even with a valid token. |
The Agent accepts only a token that is linked to exactly one customer: the customer the Agent is installed for.
Ask your BrynQ consultant or BrynQ support for the Agent token of your environment. BrynQ creates it for you and sends it securely.
Things to agree on before the token is created:
Don't use a token from the Admin Portal › API access page: those are administrator tokens for all customers, and the Agent refuses them.
When you reinstall or upgrade, the installer notices that a token is already stored. Keep Keep the existing API token (recommended) selected, or choose Replace it with a new API token and paste the new one.
You don't need to reinstall the Agent to replace the token.
BrynQ checks the new token first. It is saved only when BrynQ accepts it for your customer, so a wrong token never replaces a working one.
The installer and the BrynQ connection page tell you why BrynQ does not accept a token. For other problems, see Troubleshooting the BrynQ Agent.
| Message | What it means | What to do |
BrynQ does not know this API token (TOKEN_NOT_FOUND) | The token does not exist, was revoked, or was not copied completely. | Copy the whole token again. Still refused? Ask BrynQ for a new token. |
The API token has expired (TOKEN_EXPIRED) | The validity period of the token has passed. | Ask BrynQ for a new token and replace it on the BrynQ connection page. |
The BrynQ user this API token belongs to no longer exists (RELATED_USER_NOT_FOUND) | The token was created by a BrynQ user who has since been removed. | Ask BrynQ for a new token. |
BrynQ only accepts this API token from other IP addresses (IP_NOT_ALLOWED) | The token has an IP whitelist that does not include your server's public IP address. | Ask BrynQ to add the address shown under Public IP address to the token's whitelist, or to remove the whitelist. Then click Check again. |
BrynQ knows the token, but it is not an agent token (AGENT_TOKEN_MUST_TARGET_EXACTLY_ONE_CUSTOMER) | The token is linked to several customers or to none, for example an administrator token. | Use a token created in your own BrynQ environment (see Which token you need). |
| BrynQ links the token to another customer | The token belongs to a different BrynQ environment than this Agent. | Use the Agent token of your own environment. |
| The BrynQ platform does not respond | BrynQ is temporarily busy or unavailable. | Wait a few minutes and click Check again. |
| BrynQ cannot be reached | The server cannot make an outgoing HTTPS connection to BrynQ. | Ask your IT administrator to allow outgoing HTTPS traffic to BrynQ (see below), including through any proxy. |
The token check, the connection test and the updates all go outward from your server to BrynQ. No inbound port is needed. If your firewall or proxy only allows outgoing traffic to approved destinations, allow:
| Destination | IP address | Port |
| app.brynq.com | 20.54.225.251 | TCP 443 (HTTPS) |
Allow the host name app.brynq.com where your firewall supports it, and the IP address where it only accepts IP addresses. The Outbound connections check on the Troubleshooting page of the admin dashboard shows whether the server can reach BrynQ. The Cloudflare Tunnel needs its own outgoing port: see Network settings of the BrynQ Agent.
Don't confuse the two addresses: 20.54.225.251 is BrynQ's address, which your firewall allows. The Public IP address of your server is what BrynQ adds to the token's IP whitelist.