API Keys

API Keys provide programmatic access to Pulsimo's API without requiring user authentication.

Use Cases

CI/CD Pipelines

Add/remove endpoints during deployment

External Tools

Query health data from monitoring tools

Custom Dashboards

Fetch metrics for custom visualizations

Infrastructure as Code

Terraform, Pulumi, and other IaC tools

Creating API Keys

POST /api/v1/api-keys
Authorization: Bearer <jwt-token>
{
  "name": "CI/CD Pipeline",
  "scopes": ["endpoint:read", "endpoint:create"],
  "expires_at": "2026-01-01T00:00:00Z"
}

Important: API key is shown only once! Save it securely.

API Key Scopes

ScopePermissions
endpoint:readView endpoints and health checks
endpoint:createCreate new endpoints
incident:readView incidents
analytics:readAccess analytics data
adminFull access (use with caution!)

Using API Keys

curl -H "Authorization: Bearer pul_live_abc123..." \
  https://your-domain.com/api/v1/endpoints

Security Best Practices

🚫 Never Commit Keys: Store in environment variables or secrets manager.

🔒 Least Privilege: Only grant necessary scopes. Avoid admin scope.

🔄 Rotate Regularly: Change API keys every 90 days.