API Keys
Create, copy, and revoke API keys for programmatic access to PulsAPI.
API Keys
API keys let you interact with the PulsAPI API programmatically — pull service statuses, retrieve SLA data, or integrate PulsAPI into your own tooling.
API keys are a Pro plan feature. Upgrade to Pro to create and manage API keys.
Creating an API key
- Navigate to Settings > API Keys.
- Click Create API Key.
- Enter a name for the key (e.g., "CI/CD Pipeline", "Internal Dashboard").
- Click Create.
- Your new API key is displayed. Copy it now — it will not be shown again.
The full API key is only displayed once at the time of creation. If you lose it, you must revoke the key and create a new one. There is no way to retrieve an existing key.
Copying the key
After creating a key, click the Copy button next to the key value to copy it to your clipboard. Store it securely — for example, in a password manager or as an encrypted environment variable.
Using API keys
Include your API key in the Authorization header of every request to the PulsAPI API:
The API key authenticates requests as your account. Any action the API performs is subject to your account's plan and permissions.
Revoking an API key
If a key is compromised or no longer needed, revoke it immediately:
- Navigate to Settings > API Keys.
- Find the key you want to revoke in the list.
- Click the Revoke button.
- Confirm the revocation.
The key becomes invalid immediately. Any requests using the revoked key will receive a 401 Unauthorized response.
Security best practices
Follow these guidelines to keep your API keys secure:
- Never commit API keys to version control. Use environment variables or a secrets manager instead.
- Use descriptive names for each key so you can identify its purpose and revoke the right one if needed.
- Rotate keys periodically. Create a new key, update your integrations, then revoke the old one.
- Revoke unused keys. If a key is no longer in use, revoke it to minimize your attack surface.
- Limit access. Only share API keys with systems and people who need them.
Managing multiple keys
You can create multiple API keys — for example, one for your CI/CD system and another for a custom internal dashboard. Each key is listed in Settings > API Keys with its name, creation date, and a revoke action.
| Column | Description |
|---|---|
| Name | The label you assigned when creating the key. |
| Created | The date and time the key was generated. |
| Last Used | The last time the key was used to make an API request. |
| Actions | Revoke the key. |