API keys
Create and manage the API keys external systems use to reach the workspace.
API keys
API keys let external systems authenticate and work with the workspace over the REST API. Each key can have a limited scope, a scheduled expiry and an IP restriction.
Only workspace administrators can reach the API keys.
Creating an API key
- Click Create API key.
- Fill in its settings:
Name
How the key is identified. Use something descriptive of the system or purpose, like ERP integration or Monitoring system.
Expiry date
When the key stops working. Leave it blank for a key that never expires.
Allowed IPs
Restricts the key to specific IP addresses. Add one at a time — the field takes addresses separated by commas or spaces.
Leave it blank to allow any IP.
Permissions
Which of the workspace's robots the key can reach. Select robots individually, or select none to give access to all of them.
Rotation period
How many days until the key automatically expires and is renewed. Optional.
- Click Create.
The generated key is shown once, right after it is created. Copy it somewhere safe before closing the window — it cannot be recovered afterwards.
Editing an API key
Click the gear icon next to the key to edit its name, expiry, IPs and permissions. The key itself does not change.
Deleting an API key
Click the bin icon next to the key and confirm.
To delete several at once, select them with the checkbox and use the bulk Delete action.
Deleting a key immediately revokes access for any system using it.