Skip to main content

Platform

Check health​

GET/health

Returns {"status": "ok"} when the API process is up. No authentication.

Get the version​

GET/version

The release this API is running. No authentication, so you can check it while diagnosing an upgrade. A build that is not a release reports dev. See Upgrade.

Get the signed-in user​

GET/auth/me

Who the token belongs to, and their platform roles.

Response fields​

usernamestringoptional
The Keycloak username.
rolesarrayoptional
The realm roles in the token, such as viewer, developer and admin.

Get licence status​

GET/license/status

What the License Service says about your licence now. Any signed-in user. See Licence.

Response fields​

statusstringoptional
valid, grace, expired, invalid or unlicensed.
enforcementstringoptional
full, degraded or unlicensed.
detailstring or nulloptional
Why the licence is not valid, or how long the grace period has left.
tenant_idstring or nulloptional
Who the licence was issued to.
seatsinteger or nulloptional
The licensed seats.
seats_usedintegeroptional
The seats in use.
featuresarray or nulloptional
The licensed features.
modulesobjectoptional
Each platform module and whether the licence allows it.
limitsobjectoptional
The licence's limits, by module.
expires_atinteger or nulloptional
When it expires, as a Unix timestamp in seconds.
days_remaininginteger or nulloptional
Days until it expires.
grace_daysintegeroptional
The grace period after expiry.
upload_enabledbooleanoptional
Whether a licence can be uploaded from the console.

Upload a licence​

POST/license

Installs a new or renewed licence. Platform admin. Open even while the current licence has lapsed. The License Service checks the signature and the expiry before it keeps anything, so a bad upload leaves the current licence in force. The upload is an audit event.

Body​

licensestringrequired
The licence file's text.

Responses​

200
Installed. The body is the new status.
400
The licence is forged or malformed.
409
Uploading is off (license.storage.enabled).
422
The licence has already expired.

System status​

GET /admin/system, platform admin: the platform version, the health of every component, the licence, whether NetworkPolicy is enforced for code agents, and the registry, namespace and database revision an offline upgrade needs. Read-only. See Operations.

Was this page helpful?
On this page
Talk to our teamQuestions about licensing or sizing VoisX Orchestrate for your site? We can help.Talk to sales →