API reference

103 paths and 115 operations, generated from docs/openapi.yaml. Download the spec for full parameters, bodies and responses.

Download OpenAPI View public key

Filter endpoints

Authentication Public license endpoints take the customer’s own license_key; portal routes use a session; admin routes use a dashboard session or a kg_live_… API key.

License 4

GET/license/pubkey

Get the Ed25519 verification key

POST/license/activate

Activate a license

POST/license/verify

Verify a license activation

POST/license/deactivate

Deactivate a device or user

GET/signup/{checkout_id}

What a self sign-up form shows

POST/signup/{checkout_id}/send

Mail a confirmation code

POST/signup/{checkout_id}/verify

Confirm the code and claim the licence

Auth 9

POST/webhook/casdoor

Receive Casdoor identity events

GET/auth/providers

Sign-in methods this server offers

GET/auth/casdoor/login

Start Casdoor sign-in (OIDC authorization code)

GET/auth/casdoor/callback

Finish Casdoor sign-in

POST/auth/casdoor/exchange

Trade a Casdoor token for a Keygate session (desktop)

POST/auth/otp/send

Email a six-digit sign-in code

POST/auth/otp/verify

POST/auth/refresh

Renew the session

POST/auth/logout

Sign out

Session 2

GET/me

The signed-in account in this context

GET/me/tenants

Workspaces this account belongs to

Checkout 2

GET/pay/{checkout_id}

Hosted checkout link for a plan (root path)

GET/checkout/verify

Confirm a Stripe Checkout session on the success page

Portal 18

GET/portal/me

The signed-in user

GET/portal/licenses

The signed-in user's licenses

PUT/portal/profile

Update the signed-in user's display name

GET/portal/plans

Active plans of a product

POST/portal/usage

Record usage from a portal session

POST/portal/usage/status

Get quota status from a portal session

GET/portal/licenses/{license_key}/activations

List a license's activations

DELETE/portal/licenses/{license_key}/activations/{activation_id}

Remove an activation (free a device slot)

POST/portal/subscription/change-plan

Move a subscription to another plan

POST/portal/subscription/preview

Preview a change to a subscription's plan or seats

POST/portal/subscription/change

Change a subscription's plan or seats, as previewed

POST/portal/subscription/pending

A subscription change waiting for payment

POST/portal/subscription/cancel

Cancel a subscription

POST/portal/subscription/billing-portal

Open the Stripe customer portal

GET/portal/subscription/invoices

Invoices of a license's Stripe customer

POST/portal/updates/renew

Buy a maintenance renewal for a perpetual license

POST/portal/licenses/claim

Attach a license to the signed-in account by entering its key

POST/portal/licenses/upgrade

Upgrade a license on a free plan to a paid plan (portal session)

Seats 4

POST/invites/accept

Accept a seat invite (public, token-only)

POST/portal/seats

List seats on a license (portal)

POST/portal/seats/add

Invite a member (portal)

POST/portal/seats/remove

Remove a member (portal)

Entitlements 1

POST/license/entitlements

Check feature entitlements

Floating 3

POST/license/floating/checkout

Checkout a floating session

POST/license/floating/checkin

Release a floating session

POST/license/floating/heartbeat

Extend a floating session

Usage 2

POST/license/usage

Record usage

POST/license/usage/status

Get quota status

Releases 5

POST/license/download

Get a license-gated download URL

GET/releases/{product_slug}/feed.xml

Sparkle appcast (per-platform)

GET/releases/{product_slug}/feed.json

Velopack feed (per-platform)

GET/releases/{product_slug}/velopack/{platform}/{file}

Velopack feed and package downloads, at the URLs Velopack builds

GET/releases/{product_slug}/upgrade.json

Tauri updater manifest (latest only)

Site 3

GET/config

Public site configuration

GET/version

Server version

GET/products/{product_slug}/plans

Public plan catalogue for a pricing page

Platform 10

GET/platform/tenants

List workspaces

POST/platform/tenants

Open a workspace

GET/platform/tenants/{id}

One workspace

PATCH/platform/tenants/{id}

Rename or suspend a workspace

GET/platform/tenants/{id}/members

Members of a workspace

POST/platform/tenants/{id}/members

Add a member

PATCH/platform/tenants/{id}/members/{user_id}

Change a member's role

DELETE/platform/tenants/{id}/members/{user_id}

Remove a membership

GET/platform/settings

Platform-wide settings

PUT/platform/settings

Write platform-wide settings

Admin · Licenses 29

GET/admin/licenses

List licenses

POST/admin/licenses

Create a license

GET/admin/licenses/export

Export licenses with their keys

GET/admin/licenses/{id}

Get a license

GET/admin/licenses/{id}/key

Reveal a license key

POST/admin/licenses/{id}/rotate-key

Replace a license key

POST/admin/licenses/{id}/resend-email

Email the customer their key again

POST/admin/licenses/{id}/refund

Cancel and revoke (path kept as /refund)

POST/admin/licenses/{id}/revoke

Revoke a license

POST/admin/licenses/{id}/suspend

Suspend a license

POST/admin/licenses/{id}/reinstate

Reinstate a license

POST/admin/licenses/{id}/quantity

Set the seats of a license on a per-seat plan

POST/admin/licenses/{id}/valid-until

Set or clear a license's expiry

POST/admin/licenses/{id}/updates-until

Set or clear a perpetual license's update cutoff

POST/admin/licenses/{id}/owner

Bind a license to the account that should see it in the portal

POST/admin/licenses/{id}/owner/override

Reassign a license another account already holds

POST/admin/licenses/{id}/change-plan

Move a license to another plan of its product

POST/admin/licenses/{id}/stripe/unlink

Detach an ended Stripe subscription from a license

GET/admin/licenses/{id}/usage

Usage events and counters of a license

POST/admin/licenses/{id}/usage/reset

Reset a usage counter

GET/admin/licenses/{id}/seats

Seats of a license

DELETE/admin/licenses/{id}/seats/{seat_id}

Remove a member or cancel an invitation

GET/admin/licenses/{id}/seats/{seat_id}/key

Reveal a member's key

POST/admin/licenses/{id}/seats/{seat_id}/rotate-key

Reissue a member's key

GET/admin/licenses/{id}/addons

Add-ons attached to a license

POST/admin/licenses/{id}/addons

Attach an add-on to a license

DELETE/admin/licenses/{id}/addons/{addon_id}

Detach an add-on from a license

GET/admin/licenses/{id}/floating

Floating sessions of a license

DELETE/admin/activations/{id}

Remove an activation

Admin · Releases 12

GET/admin/releases

List releases

POST/admin/releases

Create a draft release

GET/admin/releases/{id}

Get a release

PATCH/admin/releases/{id}

Update a release's name and notes

DELETE/admin/releases/{id}

Delete a draft release

PATCH/admin/releases/{id}/notes

Update a release's name and notes (deprecated alias)

POST/admin/releases/{id}/artifacts

Add an artifact and get an upload URL

POST/admin/releases/{id}/artifacts/{aid}/finalize

Finalize an uploaded artifact

DELETE/admin/releases/{id}/artifacts/{aid}

Delete an artifact of a draft

POST/admin/releases/{id}/actions/publish

Publish a draft release

POST/admin/releases/{id}/actions/yank

Yank a published release

POST/admin/releases/{id}/actions/unyank

Restore a yanked release

Admin · Webhooks 8

GET/admin/webhooks

List webhook endpoints

POST/admin/webhooks

Create a webhook endpoint

PUT/admin/webhooks/{id}

Update a webhook endpoint

DELETE/admin/webhooks/{id}

Delete a webhook endpoint

GET/admin/webhooks/{id}/deliveries

List an endpoint's deliveries

GET/admin/webhooks/{id}/deliveries/{delivery_id}

Get one delivery

POST/admin/webhooks/{id}/deliveries/{delivery_id}/resend

Send a delivery again

POST/admin/webhooks/{id}/test

Send a test event

License 4

Signup 3

Auth 9

Session 2

Checkout 2

Portal 18

Seats 4

Entitlements 1

Floating 3

Usage 2

Releases 5

Site 3

Platform 10

Admin · Licenses 29

Admin · Releases 12

Admin · Webhooks 8