Go to Settings > API Keys, click Create Application, give it a name and scope, and click Create. Open the application and click Generate Key. Copy the key straight away: it's shown only once.
This guide is for company owners and admins who connect tools such as Power BI to Colobbo. Treat every key like a password.
1. Create an application
An application groups the keys for one tool. Click Create Application.
Field | What to enter |
|---|---|
Name | For example Power BI Integration. Required, up to 100 characters, and not already used. |
Description | What the tool is used for. |
Scope | Read Only can only read data. Full Access can read and change data, and needs the Owner role. |
Rate Limit | How many requests a minute the tool may make: 60, 120, 300 or 600. |
Click Create. You see Application created successfully.
2. Generate a key
Click the application in the list to open it, then Generate Key. Enter a Label such as Production key, choose who the key Authenticates as (requests use that person's permissions), and when it Expires: never, 30 days, 90 days or 1 year. Click Generate.
On API Key Generated, use the eye to show the key, the copy button, or Download as .txt. Store it somewhere safe, then click Done. The key is shown only once. If you close the box first, or click outside it, generate a new key.
3. Rotate or revoke a key
Rotate (from the ⋮ on a key) makes a new key. The old one keeps working for 24 hours so you can update your tool.
Revoke stops a key at once. Anything using it loses access. This can't be undone.
Deactivate on an application stops all its keys at once; Activate turns them back on. Delete (owners only) removes the application and revokes all its keys for good.
The master key (owners only)
The account owner also sees a Master Key card. A master key has full access to all data, so only create one if a tool really needs it: click Set up Master Key, then generate it the same way.
Related articles
