API Reference
Authentication
Create and manage API keys to authenticate with the ChangeVault API.
Creating an API key
- Go to Settings → API Keys in the dashboard
- Click Create API key
- Give it a name (e.g.
github-actions-prod) - Copy the key — it is only shown once
Store your API key securely. It cannot be retrieved after creation — if lost, revoke it and create a new one.
Using your API key
Pass the key in the x-api-key request header:
curl -X POST https://app.changevault.dev/api/changes \
-H "x-api-key: cvk_prod_••••••••" \
-H "Content-Type: application/json" \
-d '{"title": "Deployed v2.4.1", "risk_level": "low", "status": "completed"}'Key permissions
API keys have organization-level access. They can create changes on behalf of the organization.
API access requires the Pro plan or higher. Free plan organizations can only log changes via the dashboard.
Revoking a key
Go to Settings → API Keys, find the key and click Revoke. The key will stop working immediately.
Key expiration
You can set an expiration date when creating a key. Expired keys are automatically rejected.