Skip to main content
API keys let you authenticate requests to the Atmet API from your own scripts, applications, or CI/CD pipelines — without using your personal login credentials. Each key is scoped to a specific workspace and carries the permissions of the member who created it.

Key Format

Every Atmet API key starts with the prefix atmet_ followed by 40 lowercase hexadecimal characters:
Your credentials are stored securely and never exposed after creation. This means you must copy the key at the moment it is created. It cannot be retrieved later.

Create an API Key

1

Open API Keys settings

Navigate to Settings → API Keys in the left sidebar.
2

Click New Key

Click New API Key in the top-right corner.
3

Name your key

Enter a descriptive name that identifies what this key is used for — for example, GitHub Actions Deploy or Local Dev Script. Good names make it easier to audit and rotate keys later.
4

Set an optional expiry date

If you want the key to stop working automatically after a certain date, select an Expiration Date. Leave this blank for a non-expiring key.
5

Copy the key immediately

After clicking Create, Atmet displays the full raw key exactly once. Copy it to a secure location — a password manager or secrets vault — before closing the dialog.
The raw API key is shown only once at creation time. If you close the dialog without copying the key, you must revoke it and generate a new one. Atmet cannot display or recover the original key.

Use Your API Key

Pass your API key in the Authorization header as a Bearer token on every request. You must also include the x-workspace-id header to identify which workspace the request targets. cURL example:
TypeScript / JavaScript example:
Store your key in an environment variable (e.g. ATMET_API_KEY) rather than hardcoding it in your source files. Read it at runtime with process.env.ATMET_API_KEY in Node.js or the equivalent in your language of choice.

Manage Existing Keys

The Settings → API Keys page lists all keys created in the workspace, showing:
The raw key value is never shown in the list. Only the metadata above is displayed to protect your credentials.

Revoke a Key

Revoking a key immediately invalidates it. Any requests using that key will receive a 401 Unauthorized response.
1

Open Settings → API Keys

Navigate to the API Keys list.
2

Find the key to revoke

Locate the key by name or creation date.
3

Click Revoke

Click the menu next to the key and select Revoke. Confirm the action in the dialog.

Security Best Practices

Treat API keys like passwords. Follow these practices to keep your workspace secure.

Never commit keys to source control

Use environment variables or a secrets manager. Add .env to your .gitignore to prevent accidental commits.

Set expiry dates

Short-lived keys reduce the blast radius if a key is ever leaked. Set expiry dates for all keys used in automated pipelines.

Rotate keys regularly

Create a new key, update your application to use it, and revoke the old key on a regular schedule — at minimum every 90 days.

Use one key per application

Create separate keys for each script or service. If one is compromised, you can revoke it without affecting other integrations.