Skip to content
Console
Menu

Queues

Workflows

Getting Started

Authentication

KV Store

Licence keys

A Licence Key is one Ed25519 signing key Money holds for an environment.

A Licence Key is one Ed25519 signing key Money holds for an environment. The private half is generated here (or imported once, for a key already pinned in shipped clients), sealed with Money's seal keys, and never returned or logged. The public half is exported keyless at GET /v1/money/licence_keys/{uid}, in the raw base64url form a client pins.

Service Sylphx Money · Resource type money.sylphx.com/LicenceKey · Name pattern orgs/{org}/projects/{project}/envs/{env}/licence_keys/{licence_key} · Shape spec_status

#Fields

FieldTypeWhat it is
namestringorgs/{org}/projects/{project}/envs/{env}/licence_keys/{licence_key}.
uidstringlkey_<cell><ulid>; never reused. The keyless public export is addressed by it. Output only.
metaResourceMetaResource metadata.
specLicenceKeySpecDesired state. Required.
statusLicenceKeyStatusObserved state. Output only.

#Methods

Every method of the collection, in the registry's order, with the scope it needs. The full request, response and examples are one link away.

MethodCallWhat it does
POSTgenerateGenerates 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.
POSTimportImports 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.
POSTretireRetires a licence key: it stops signing new terms and stays exported for verification.
GETgetGets a licence key (its public half, never the private).
GETlistLists licence keys, newest first.

#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.

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

#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.

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

#retire

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

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).

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.

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