Reference For: developers

API: licence

Operations of the licence tag of the native REST API.

Offline licence entitlements and free-tier limits (decision L-121)

GET /v1/licence

Effective entitlements and live counters.

CLI
kyvernon licence show

Responses

StatusDescriptionSchema
200OKLicenceStatus
401Not authenticated, or the session is restricted (error.mfa_required, error.password_rotation_required)ErrorBody
403Permission denied; args.privilege names the missing privilegeErrorBody

POST /v1/licence/install

Install a signed licence file.

CLI
kyvernon licence install <payload> <signature>

Request body

application/json: InstallLicenceRequest

NameTypeRequiredDescription
payloadstringyesLicence payload JSON (the signed document).
signaturestringyesDetached minisign signature file text.

Responses

StatusDescriptionSchema
200OKInstalledLicenceView
400Invalid argument; the error body names the fieldErrorBody
401Not authenticated, or the session is restricted (error.mfa_required, error.password_rotation_required)ErrorBody
403Permission denied; args.privilege names the missing privilegeErrorBody
412Failed precondition; the error body says whichErrorBody

DELETE /v1/licence/{id}

Remove an installed licence. Running virtual machines are not stopped.

CLI
kyvernon licence remove <id>

Parameters

NameInTypeRequiredDescription
idpathstringyesLicence id

Responses

StatusDescriptionSchema
204Done; no body
401Not authenticated, or the session is restricted (error.mfa_required, error.password_rotation_required)ErrorBody
403Permission denied; args.privilege names the missing privilegeErrorBody
404Not found (or not visible to the caller)ErrorBody

Version 0.1.