Skip to content
Console
Menu

Queues

Workflows

Getting Started

Authentication

KV Store

sylphx money licence_keys

Every sylphx money licence_keys command: its argument, its flags and a run line.

The licence_keys commands of Sylphx Money, as the CLI spells them: the same calls as the licence_keys API page, typed for the shell. Install, sign in and the grammar are on the CLI index.

#generate

Generates a licence key: Money creates the Ed25519 key, seals it, and never returns the private half. Needs the approval-class scope, which the developer role does not hold.

NAME — the resource's name; a bare id is enough below the linked project.

CLI

Shell
sylphx money licence-keys generate orgs/acme/projects/shop/envs/production

POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/licence_keys:generate · scope billing:licence_keys.approve · effect write · Request, response and examples

Flags

FlagTypeWhat it does
--licence-key-idstringThe key's id; ^[a-z]([a-z0-9_-]{0,61}[a-z0-9])?$. Empty: Money assigns one.
--specjsonShown to operators.

#import

Imports an existing Ed25519 key (PKCS8), for a key already pinned in shipped clients. Refused unless the expected public key is the imported key's public half.

NAME — the resource's name; a bare id is enough below the linked project.

CLI

Shell
sylphx money licence-keys import orgs/acme/projects/shop/envs/production

POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/licence_keys:import · scope billing:licence_keys.approve · effect write · Request, response and examples

Flags

FlagTypeWhat it does
--licence-key-idstringThe key's id; as on GenerateLicenceKeyRequest. Required. Required.
--private-key-pkcs8stringThe Ed25519 private key as PKCS8 DER in standard base64. Write-only: sealed on import, never returned. Required. The value is never returned.
--expected-public-keystringThe public key shipped clients pin, raw base64url without padding. The import is refused unless it is the public half of the imported key. Required.
--specjsonShown to operators.

#retire

Retires a licence key: it stops signing new terms and stays exported for verification.

NAME — the resource's name; a bare id is enough below the linked project.

CLI

Shell
sylphx money licence-keys retire orgs/acme/projects/shop/envs/production/licence_keys/licence-key

POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/licence_keys/licence-key:retire · scope billing:licence_keys.approve · effect write · Request, response and examples

#get

Gets a licence key (its public half, never the private).

NAME — the resource's name; a bare id is enough below the linked project.

CLI

Shell
sylphx money licence-keys get orgs/acme/projects/shop/envs/production/licence_keys/licence-key

GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/licence_keys/licence-key · scope billing:read · effect read · Request, response and examples

#list

Lists licence keys, newest first.

PARENT — optional: the CLI fills it from the linked project or the key's scope when it is left out.

CLI

Shell
sylphx money licence-keys list orgs/acme/projects/shop/envs/production

GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/licence_keys · scope billing:read · effect read · Request, response and examples

Flags

FlagTypeWhat it does
--page-sizeintAt most this many; default 50, clamped to 1000.
--page-tokenstringnext_page_token of the previous page.