Skip to main content

Step 4 · Generate an API key

At the end of this step you'll have one API key secret (copied into your secret store) and up to 4 remaining key slots.

This is the hand-off from human to machine: a superadmin, in a portal session with a fresh step-up, mints the key your server will use from then on.

Who can do this: a superadmin, with a completed 2FA step-up.

  1. Portal → API keys → Generate key.
  2. Optionally set a label and an expiry (a duration or an end date; omit both for a perpetual key).
  3. Complete the 2FA step-up prompt.
The secret is shown once

The full API key is displayed only at creation. Orbitum stores only a hash and can never show it again. Copy it into a secret manager / .env now. If you lose it, you must rotate to get a new one.

For key limits, zero-downtime rotation, revocation, and secret handling, see Managing your API key.

Next: Accept a pool →