Authentication details can evolve as API coverage expands. Use this page as the current guide to how Watchman Tower handles authenticated API access.
Overview
API keys provide programmatic access to Watchman Tower. Each key can:- Grant account access with configurable permissions
- Remain active until revoked
- Be revocable at any time
- Require secure storage
Base URL
API requests are made to:Authentication Method
API keys can be passed via the Authorization header:Key Format
API keys follow this format:Generating API Keys
API keys are managed through:- Dashboard: Settings → API Keys → Generate New Key
- API Endpoint: Create keys programmatically (requires existing key)
- Name: Descriptive identifier (e.g., “CI/CD Pipeline”, “Production”)
- Permissions: Read-only or full access
- Expiration: Optional expiration date
- IP Whitelist: Optional IP restrictions (Enterprise)
Key Permissions
Read-Only Access
Typical read-only access allows:- List and view monitors
- Get monitor status and metrics
- View incidents and history
- Access uptime data
- Creating or modifying monitors
- Changing alert settings
- Managing team members
- Deleting resources
Full Access
Full access allows:- All read operations
- Create, update, delete monitors
- Configure alerts and integrations
- Manage account settings
Security Best Practices
Environment Variables
Store keys in environment variables, never in source code
Separate Keys
Use different keys for different services and environments
Minimum Permissions
Use read-only keys when write access isn’t needed
Regular Rotation
Rotate keys every 90 days or when team members change
Monitor Usage
Review key usage regularly and revoke unused keys
Never Commit
Add keys to .gitignore and use placeholder values in version control
Rate Limiting
API usage can be subject to rate limits based on plan and endpoint behavior: Refer to response headers and the current product documentation for the latest rate limit behavior in your workspace. Example response headers:Error Responses
Authentication errors return standard HTTP status codes:| Status | Code | Description |
|---|---|---|
| 401 | UNAUTHORIZED | Invalid or missing API key |
| 403 | FORBIDDEN | Insufficient permissions for operation |
| 429 | RATE_LIMITED | Rate limit exceeded |
