API Keys

API keys let tools outside of PruTAN authenticate as your team and trigger work programmatically — most commonly running a saved suite from a CI/CD pipeline. Each key belongs to a team (workspace), so a key only has access to the team it was created in.

You manage API keys from Settings → API Keys. The list shows every key for the currently selected team, with its name, a masked preview of the key, its status, and its created and expires dates.

API keys are team-scoped. Switch teams from the workspace selector to manage that team's keys — each team has its own set.

Generating a Key

  1. Open Settings and scroll to the API Keys section.
  2. Click Generate.
  3. (Optional) Give the key a name so it is easy to recognize later. A suggested name is filled in for you — keep it or replace it.
  4. Click Generate.

PruTAN then shows the full key once, in a confirmation dialog with a Copy button.

Copy and store the key securely right away. For security, the full key is shown only at creation — it cannot be recovered or displayed again. Afterwards the list shows only a masked preview (for example ak_M••••••••****). If you lose a key, delete it and generate a new one.

A newly generated key is Active and expires one year after it is created (the exact expiry is shown on the key and in the creation dialog).

Searching Keys

Use the Search API keys box above the table to filter the list by name as you type.

Key Status

Each key shows one of two states:

  • Active — the key is valid and can be used to authenticate.
  • Expired — the key has passed its expiry date and is no longer accepted. Generate a new key to replace it.

Renaming a Key

  1. Click the ⋮ (actions) menu on the key's row.
  2. Select Edit.
  3. Update the name and confirm.

Renaming only changes the label — the key value, status, and expiry are unaffected.

Only the name can be edited. The key value itself is never editable; to change the value, delete the key and generate a new one.

Deleting a Key

  1. Click the ⋮ (actions) menu on the key's row.
  2. Select Delete and confirm.
Deleting a key is permanent. Any pipeline, script, or integration still using that key will immediately start failing to authenticate. Make sure the key is no longer in use — or have a replacement ready — before deleting it.

Using an API Key

The main use for an API key is triggering a saved suite from outside PruTAN — for example as a step in your CI/CD pipeline, so a suite run becomes part of your build or release process.

The suite's Run from CI/CD dialog generates ready-to-use snippets (Jenkins, GitHub Workflow, AWS CodeBuild, and a direct curl command) that authenticate with an API key. For the full walkthrough and the snippets themselves, see Running a Suite from CI/CD.

  • For security, the snippets never embed your real key — they use a <YOUR_API_KEY> placeholder (or a secret/credential reference). Paste your actual key in, or store it as a secret in your CI tool, before running.
  • Use a key that belongs to the same team as the suite you are running.

Keeping Keys Secure

  • Treat an API key like a password — anyone with it can act as your team.
  • Store keys in your CI/CD tool's secrets/credentials store, never in committed source files.
  • Use separate keys for separate pipelines or integrations so you can rotate or revoke one without disrupting the others.
  • Rotate keys periodically: generate a new key, update your pipelines, then delete the old one.
Table of Contents