API Authentication
Secure access to Upstat’s API using API keys.
Generating API Keys
Create API keys from your account settings:
- Go to Settings → API Keys
- Click Generate New Key
- Give your key a descriptive name
- Copy the key immediately - it won’t be shown again
![Placeholder: API Key Generation Dialog with Name Field]
Using API Keys
Include your API key in all requests:
curl -H "Authorization: Bearer YOUR_API_KEY"
https://api.upstat.io/v1/monitors Key Security
Keep your API keys secure:
- Never commit keys to version control
- Use environment variables in your applications
- Rotate keys regularly
- Create separate keys for different applications
Key Permissions
API keys inherit the permissions of the user who created them:
- Account Owner - Full access to all resources
- Project Manager - Access to assigned projects
- Contributor - Limited write access
- Viewer - Read-only access
Revoking Keys
To revoke a compromised key:
- Go to Settings → API Keys
- Find the key to revoke
- Click Delete
- Update your applications with a new key
![Placeholder: API Keys List with Delete Actions]
Best Practices
- Name keys descriptively (e.g., “Production Monitoring Script”)
- Use different keys for different environments
- Monitor key usage in audit logs
- Set up alerts for unusual API activity
Learn more