Skip to main content
API keys authenticate Calibrate in the GitHub Action or the REST API. You can create multiple keys per workspace.

​
Creating an API key

1

Open Workspace settings

Go to Workspace settings → API keys and select the API keys tab.
2

Click Create key

Click Create key in the top right of the API keys section.
3

Name your key

Enter a Name for the key (for example, GitHub Action CI).
4

Save your key

Click Create key. Your API key will be displayed once.
Copy the key immediately. You will not be able to view the full key again after closing the dialog.

​
Using your API key

Include the key in the X-API-Key header with every request:
For using it with the Calibrate GitHub Action, store the key as a GitHub secret named CALIBRATE_API_KEY.

​
Managing keys

The API keys table lists every key with three columns: To permanently disable a key, click Revoke. Any integration using that key will immediately lose access.

​
Best practices

​
Use descriptive names

Name keys after their purpose (for example, GitHub Action CI or Staging automation) so you can identify them in the table later.

​
Rotate keys regularly

Create a new key, update your integrations, then Revoke the old one — especially for production CI pipelines.

​
Revoke unused keys

Promptly revoke keys that are no longer in use.

​
Store keys as secrets

Never commit API keys to version control. Use GitHub secrets, environment variables, or your team’s secret manager.

​
Next steps

API reference

Explore the full API documentation

GitHub Action

Use API keys in your CI/CD pipeline