Skip to content

Management API ​

Used by the dashboard, authenticated with a session token from POST /api/v1/auth/login. Each route needs a permission; the gateway rejects anything your role does not allow.

Auth ​

MethodPathBody
POST/api/v1/auth/signup{ companyName, email, password }
POST/api/v1/auth/login{ email, password } → { token, user }
GET/api/v1/auth/meCurrent user, role, permissions and plan
POST/api/v1/auth/password{ currentPassword, newPassword }

Products and policies ​

MethodPathPermission
GET/api/v1/productsproducts.read
POST/api/v1/products { name, code?, description? }products.write
GET/api/v1/products/{id}products.read
GET/api/v1/policies?productId=products.read
POST/api/v1/policies { productId, name, type, maxMachines?, durationDays? }products.write
PATCH/api/v1/policies/{id} { name?, type?, maxMachines?, durationDays? }products.write

Licenses ​

MethodPathPermission
GET/api/v1/licenses?productId=&status=licenses.read
POST/api/v1/licenses { policyId, customerEmail, customerName? }licenses.write
GET/api/v1/licenses/{id}licenses.read
POST/api/v1/licenses/{id}/suspend · /reinstate · /revokelicenses.write
GET/api/v1/licenses/{id}/file (offline license)licenses.read
GET/api/v1/signing-keylicenses.read
GET/api/v1/activations?licenseId=licenses.read
POST/api/v1/activations/{id}/deactivatelicenses.write

API keys ​

MethodPathPermission
GET/api/v1/api-keysapi_keys.read
POST/api/v1/api-keys { name } → includes the key, onceapi_keys.write
DELETE/api/v1/api-keys/{id}api_keys.write

Organization and team ​

MethodPathPermission
GET/api/v1/org (plan, limits, usage)any member
PATCH/api/v1/org { name }org.manage
GET/api/v1/org/membersstaff.read
POST/api/v1/org/members { email, name?, roleId, password }staff.write
PATCH/api/v1/org/members/{id} { roleId?, status? }staff.write
GET/api/v1/org/rolesstaff.read
POST · PUT · DELETE/api/v1/org/roles[/{id}] { name, description?, permissions[] }staff.write

Analytics ​

MethodPathPermission
GET/api/v1/stats/validation/report?range=24h|7d|30danalytics.read
GET/api/v1/stats/licensing/report?range=24h|7d|30danalytics.read
GET/api/v1/stats/validation/geo?hours=24analytics.read

SunLicense Cloud is in alpha.