Skip to main content

Create and revoke a Loopster API key

Create a named API key with a role and an expiry for another tool, and revoke it on its own.

Written by Umer Ishaq

A Loopster API key lets another tool use Loopster in a workspace.

Where do I find the keys?

Open Settings, then Loopster API. The page says: "Keys and agents that let other tools use Loopster's API in this workspace. Keys for services Loopster runs on, like Apollo, are in Connections."

Under API Keys each key shows its name, who created it and when, when it was last used and when it expires, the key with only its last four characters, a role menu, and Revoke. The page says: "Each key has a name and a role, and can be revoked on its own. Keep them secret; do not share them publicly."

The Loopster API settings page with the Settings menu on the left. The Loopster API item in the menu is outlined in red. The page shows the Loopster API title, a line about keys and agents that let other tools use the API in this workspace, an API Keys heading with a line saying each key has a name and a role and can be revoked on its own and should be kept secret, and the key list box.

What does a key's row look like?

The line under a key's name reads, for example, "Created by <name> on <date> · last used <date> · expires <date>". The dates are written day/month/year. The key shows as loopster_sk_… followed by its last four characters.

The row has two controls, a role menu and Revoke. It has no button to edit, rename, copy or rotate the key.

How do I create a key?

  1. Under Create a key, type a name in the box (the hint shows e.g. Zapier, nightly sync). The text says "Name it after what will use it. Give it the least access that integration needs."

  2. Pick a role. The menu starts on Editor — read, write and run. The options are:

    • Member — read only

    • Editor — read, write and run

    • Admin — everything an API key can do

  3. Pick when it ends. The menu starts on Never expires. The options are Never expires, Expires in 30 days, Expires in 90 days and Expires in 1 year.

  4. Next to it is a tick box, Can't start paid work. It is empty when the page opens. The page gives no description of it, and no hint appears when you hover over it. If you are not sure what it does, ask us with Need Help? at the top right of any page before you tick it.

  5. Click Create key.

The Create a key form: a name box, a role menu showing Editor - read, write and run, an expiry menu showing Never expires, an empty Can't start paid work tick box and a Create key button.

Can I change a key's role?

Each key's row has a role menu. On a key whose role was editor, the menu offered only editor and member. The menu did not offer admin.

The form for a new key offers Member — read only, Editor — read, write and run and Admin — everything an API key can do.

The Loopster API docs say a key's role can be lowered in place and can never be raised.

How do I revoke a key?

Click Revoke on the key's row.

Good to know

  • Keys belong to a workspace. A workspace's own settings page lists its keys too.

  • Give a key the least access it needs, and keep it out of public places.

  • API Docs in the Settings sidebar opens the docs home page, docs.loopster.ai, in a new tab. It does not open a page about keys.

Related Articles
Did this answer your question?