Skip to main content

Licenses

Licenses gate VPN access by tier. Each license has a plan, usage counter, and optional expiry.

License Plans

PlanDescriptionMax Uses
TRIALEvaluation5 connections
STARTERSmall teamsHigher cap
PROProductionUnlimited
ENTERPRISECustom SLAUnlimited + custom config

Validate License (SDK Use)

POST /cvault/v1/licenses/validate

Headers: X-API-Key

{"key": "cvlt_pro_abc123"}

Response:

{
"valid": true,
"plan": "PRO",
"usesRemaining": null
}

Admin Endpoints

Admin endpoints require the X-Admin-Key header.

MethodPathDescription
POST/cvault/v1/licensesCreate a license
GET/cvault/v1/licensesList licenses (filter by tenantId, product, plan, status)
GET/cvault/v1/licenses/:keyGet single license
POST/cvault/v1/licenses/:key/revokeRevoke a license

Create license:

{
"tenantId": "uuid",
"product": "cvault-vpn",
"plan": "TRIAL",
"maxUses": 5,
"expiresAt": "2026-12-31T00:00:00Z"
}

License Statuses

StatusDescription
ACTIVEValid and usable
REVOKEDManually revoked by admin
EXPIREDPast expiresAt date

See Licenses API Reference for full endpoint documentation.