Skip to Content
This documentation is provided with the HEAT environment and describes this HEAT instance.

Offline Tokens

An offline token is a long-lived credential, valid for twelve months, for a device or a script that uploads to HEAT through the v2 API. It is the right credential for a capture device or an automated uploader that cannot sign in interactively. Open Developer Tools, then Offline Tokens (/admin/developer-tools/offline-tokens).

Issuing and revoking tokens is Administrator only. A Developer sees the page but cannot mint or revoke.

Issuing a token

Press Generate token. The dialog shows the token once, with its twelve-month lifetime. Copy it immediately and store it securely, because it cannot be retrieved after you close the dialog.

⚠️

The token is shown once and grants v2 API access for a year. Treat it as a credential. If a device is lost or a token leaks, revoke it here.

Revoking a token

Each token row offers a revoke action, which asks you to confirm against a hint of the token. Revoking takes effect at once, so the device stops being able to upload.

What to use it for

The Usage guide tab describes the intended uses and a short workflow. Use offline tokens for:

  • Simulators and capture applications.
  • Automated upload scripts.
  • Long-running devices that cannot log in interactively.

Do not use an offline token for operator login, user administration or day-to-day site settings. Those are interactive actions for a signed-in operator.

A device typically lists projects, lists session templates, creates a session, then uploads data to the session’s input node, all against the v2 API with the token as a bearer credential.

Opens your browser's print dialog. Choose "Save as PDF" as the destination.