BrambleHelp
How-to guideDevelopersAdmins

Create and manage your API keys

Make an API key so a script or another system can use Bramble as you, and revoke keys you no longer need.

Updated 14 November 20261 min read

An API key lets a script, server or other product call Bramble's API as you. It can do whatever you can do, so treat it like your password.

#Create a key

  1. Open My account from your photo or initials, then the API Keys tab.
  2. Select Create key, then Generate key.
  3. Select Copy and store the key somewhere safe, such as a password manager.

Important

The key is only shown once. Bramble keeps a record that it exists, but not the key itself, so it can't be shown again. If you lose it, revoke it and make a new one.

#Use the key

Send it in the X-API-Key header:

Bash
curl https://yourcompany.brambleit.cloud/api/user/name \
  -H "X-API-Key: $BRAMBLE_KEY"

See Calling the API for addresses, errors and examples.

#Revoke a key

On the API Keys tab, find the key by when it was created, and select Revoke. Anything using it stops working straight away.

The list shows each key's Created and Expires dates and whether it's still Active. Revoke any you no longer use.

Note

If your account is blocked or removed, its API keys stop working too.