API Reference

Complete reference for the KeyEnv REST API, generated from the OpenAPI 3.1.0 specification.

Base URL

https://api.keyenv.dev

OpenAPI specification

The machine-readable specification is published alongside these docs:

• openapi.yaml
• openapi.json

Import either file into Swagger Editor, Postman, Insomnia, or an AI agent to explore the API programmatically.

Authentication

Every endpoint except /health and /api/v1 requires a bearer token in the Authorization header. Both a Clerk JWT (web dashboard) and a KeyEnv service token (CI/CD, prefix st_) are accepted.

curl -H "Authorization: Bearer $KEYENV_TOKEN" \
  https://api.keyenv.dev/api/v1/projects

Endpoint groups

• Health: Health check endpoints
• Auth: Authentication and user sync
• Users: User management
• Teams: Team management and collaboration
• Invitations: Team invitation management
• Projects: Project management
• Environments: Environment management within projects
• Secrets: Secret management (encrypted key-value pairs)
• Permissions: Environment-level access control
• Tokens: Service token management for CI/CD
• Rotations: Automated credential rotation for database secrets
• Scans: Secret scanning for detecting hardcoded secrets
• ESO: External Secrets Operator (ESO) webhook endpoints for Kubernetes integration.
• Audit: Audit log access
• Billing: Billing and usage information
• CLI: CLI authentication endpoints for device authorization flow
• Account: GDPR and account management