API keys

An API key lets a script or application call the FlowHunt API as your workspace without signing in. Keys belong to the workspace, not to you personally, so calls made with one act on that workspace.

Create a key#

1. Open the API Keys tab

   Click Settings in the account area, then the API Keys tab.

2. Add the key

   Click Add API Key. In the Create API Key dialog, enter a Name that tells you where the key is used, for example “Nightly export script”. Click Add API Key to confirm.

3. Copy it now

   The next dialog shows the key with a Copy to clipboard button. FlowHunt shows the full key only once and cannot show it again. Store it in a secrets manager or an environment variable, never in code you commit.

If you lose a key, create a new one and remove the old one.

Use the key#

The same dialog has Try API key, which opens the API reference at api.flowhunt.io/docs. The reference lists every endpoint and shows how to send the key. A PHP SDK button links to the FlowHunt PHP package for PHP projects.

Manage your keys#

The API Keys list shows each key’s Name, a masked version of the key, when it was Last used and its Valid to date.

• Rename or set an expiry. Open a key and change its Name or Valid to date, then click Update API Key. The expiry date can be set only after creation.
• Remove a key. Open it and click Remove API Key, then confirm. Anything still using that key will stop working.
• Search. Use the search box above the list to find a key.

Use Last used to find keys nobody needs any more. A key that was never used, or not for months, is a good candidate to remove.

Who can do this#

Owner and Admin can create, edit and remove keys. Editor can see the list and create keys but cannot edit or remove them. Member, Guest and Maintainer do not see the tab. See team and roles.

Your plan does not cap how many keys you create. Cancelled workspaces cannot create keys.