Docs menu

API Keys

Goal: Get a key for calling your workspace's REST API, and revoke it when you are done.

Open APIs -> API Keys: Access tokens, Workspace API keys as JWTs. A key is for the REST API; the MCP server does not take one - see MCP Server.

Make a key

The expiration presets:

PresetSuggested for
15 minutesCLI smoke tests
1 hourShort automation
8 hoursFull workday
24 hoursDaily rotation
7 daysTemporary integration
30 daysLong-lived service
90 daysThe longest a key may live
  1. Choose an expiration: a preset, or a Custom duration (minutes) up to 90 days.
  2. Under Access Rights (Scopes), tick the rights the key carries. They are the rights you hold; with all ticked it reads All permissions included.
  3. Click Generate JWT.

The key is shown once, with Copy to clipboard and Clear. Store it in your secrets manager; "It is never persisted by Open Industrial." Send it as a bearer token in the Authorization header.

TIP

"A key carries at most the rights you hold now, and only the ones you chose." If your rights shrink, the key's shrink with them on its next call.

Your keys

Your API keys lists the keys you made in this workspace, with when each expires. Revoke stops a key: "Revoke it below and it stops working on its next call." A revoked key shows Revoked.

Inspect a token

Paste a JWT into Paste a JWT here... to read its user, workspace, rights and times. This runs in your browser; nothing is sent.

Save and Deploy

Making and revoking a key happen at once; nothing is saved to the workspace and nothing waits for Deploy.

Rights

Any signed-in member can make keys. A key carries only rights you hold.

Azi and agents

Keys are made by a person here; Azi and agents do not make or propose them.

Messages you may see

WhenMessage
Making a key failedWe could not generate a token. Try again or come back later.
Revoking failedWe could not revoke that key. Try again.
You hold no rightsNo access rights configured for this workspace.
No keys yetYou have no API keys in this workspace.
Copying is blockedCopy to clipboard is not available in this browser.

Next steps

On this page