API keys

An API key is what an external service presents to prove it is allowed to work on your project. Each key has a name you choose, a status, and a full value that is shown only once. From the API Access tab of a project you create a key, read the list of the ones already there, rename or disable one, and delete one you no longer want.

Before you start — Creating, editing and deleting keys is reserved to a project's administrators. Another member opens the tab and reads the list, but has no Create an API key button and no Detail button on any row — and the pages behind them send them back.

Note — Creating, editing and deleting all happen in a panel that slides in from the right, over the list. The panel carries the action's title, a close (✕) button and a View full page link at the bottom. The outcome is written in the panel — you're never sent to another page. Closing it — with ✕, by clicking the greyed-out area beside it, or by pressing Esc — refreshes the list behind so it shows what you just did.

Create an API key

The full key exists in readable form for one page view only. Plan to copy it before you start.

1. Open your project, then the API Access tab.
2. Click Create an API key — the button above the list, or the one in the

No API access panel if this is your first key.

1. On Create an API key, enter a Name. It's for you to tell your keys

apart, as the helper line suggests: Example: Production, test, integration. Up to 200 characters.

1. Click Next.
2. The API key has been created. appears in the panel. Close it.
3. The list behind refreshes with the new key at the top, its full value in a

read-only box under its name. Copy it now.

An email confirming that a key was created is sent to you.

Important — copy this key now, it will not be shown again. is printed in red under the box, and it's literal: leaving the list or reloading it replaces the full value with a preview like sk-project-...a1b2, and nothing brings the full key back. If you lose it, delete the key and create another.

Note — A key with no name is refused with The API key name is required. — the panel stays open with what you typed.

Note — A new key can do anything your project can. There's no way to narrow what a key is allowed to reach.

Read your project's keys

1. Open your project, then the API Access tab.
2. Read the list — one row per key, with these columns:

• API key — the name you gave it, then its value. That's the full value

just after creation, and a preview of the last four characters from then on.

• Status — Activated for a key that works, Suspended for one that

has been turned off. The Detail panel calls that same state Disabled.

• Created by — the email address of the person who created it.
• Created on — the date and time it was created.

1. Use the pagination buttons (Previous / Next) to browse a long list.

The counter beside them reads the rows you're on and the total, as 1-50 | 63.

The line under the list — API keys let you connect an external service to this project. — is a reminder, not a link.

Note — A brand-new key reads New on the one view that shows its full value, then Activated from the next view on.

Note — A project with no key at all shows No API access and No API key has been created on this project. in place of the list.

Note — Deleted keys are gone from the list for good; there's no filter or archive that brings them back.

Rename a key or disable it

Disabling is the reversible way to stop a key: it stays on the list and you can turn it back on.

1. Open the API Access tab, then click Detail on the key's row. The

Detail panel opens on API key details.

1. Change the Name, or set Status to Active or Disabled.
2. Click Save.

You'll see The API key has been updated. Close the panel and the row shows the new name and status.

Important — Disabling a key blocks every call that uses it, straight away. Anything that was signing its requests with that key stops working until you set it back to Active.

Note — The rest of the panel is read-only: the API key preview, the User who created the key, the Created date and Last used, the last time a call presented it. Last used stays empty for a key nothing has called yet.

Delete a key

Deleting is permanent. Disable the key first if you only want to stop it for a while.

1. Open the API Access tab, then click Detail on the key's row.
2. Scroll to the grey box at the bottom, headed Delete this API key. —

it warns The key will no longer be usable.

1. Click Delete.
2. Close the panel.

The API key has been deleted. appears in the panel and both the Save and the Delete buttons disappear, so nothing can be done to the key any more. The list behind refreshes without it, and an email is sent to whoever created the key.