Skip to content
YomiroYomiro Docs

API keys

API keys are how machines authenticate — scripts, CI pipelines, and the gateway daemon. People use SSO; machines use these.

Issuing a key

Section titled “Issuing a key”

The API keys page for issuing CLI and gateway tokens

Create a key from this page and copy it immediately. Tokens are shown once, at creation. If you lose one, issue a new key and revoke the old one — there is no way to reveal it again.

Keys are prefixed yom_pat, which makes them easy to spot in a config file or a secret scanner.

Using a key

Section titled “Using a key”

The CLI picks up a token from, in order of precedence:

  1. The --token flag
  2. The YOMIRO_API_TOKEN environment variable
  3. Whatever yomiro auth login stored

For CI, the environment variable is the one you want:

Terminal window
export YOMIRO_API_TOKEN="yom_pat_..."
export YOMIRO_API_URL="https://api.your-org.yomiro.io"
yomiro device list

Housekeeping

Section titled “Housekeeping”
  • One key per consumer. A key per pipeline or per gateway means revoking one does not break everything else.
  • Revoke on departure. A key outlives the person who created it.
  • Never commit one. Use your CI provider’s secret store.
Section titled “Related”