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
| Status | Description | Schema |
|---|
| 200 | OK | LicenceStatus |
|---|
| 401 | Not authenticated, or the session is restricted (error.mfa_required, error.password_rotation_required) | ErrorBody |
|---|
| 403 | Permission denied; args.privilege names the missing privilege | ErrorBody |
|---|
POST /v1/licence/install
Install a signed licence file.
- CLI
kyvernon licence install <payload> <signature>
Request body
application/json: InstallLicenceRequest
| Name | Type | Required | Description |
|---|
payload | string | yes | Licence payload JSON (the signed document). |
|---|
signature | string | yes | Detached minisign signature file text. |
|---|
Responses
| Status | Description | Schema |
|---|
| 200 | OK | InstalledLicenceView |
|---|
| 400 | Invalid argument; the error body names the field | ErrorBody |
|---|
| 401 | Not authenticated, or the session is restricted (error.mfa_required, error.password_rotation_required) | ErrorBody |
|---|
| 403 | Permission denied; args.privilege names the missing privilege | ErrorBody |
|---|
| 412 | Failed precondition; the error body says which | ErrorBody |
|---|
DELETE /v1/licence/{id}
Remove an installed licence. Running virtual machines are not stopped.
- CLI
kyvernon licence remove <id>
Parameters
| Name | In | Type | Required | Description |
|---|
id | path | string | yes | Licence id |
|---|
Responses
| Status | Description | Schema |
|---|
| 204 | Done; no body | |
|---|
| 401 | Not authenticated, or the session is restricted (error.mfa_required, error.password_rotation_required) | ErrorBody |
|---|
| 403 | Permission denied; args.privilege names the missing privilege | ErrorBody |
|---|
| 404 | Not found (or not visible to the caller) | ErrorBody |
|---|
Version 0.1.