Skip to main content

Admin API

Scope

The Admin API provides privileged operations for system-wide configuration, tenant provisioning, and platform health management. Access is restricted to platform administrators.

Definitions

NameDescription
POST /admin/tenantsProvision a new tenant with default configuration
DELETE /admin/tenants/{tenantId}Decommission a tenant and revoke all associated credentials
GET /admin/healthReturn platform health status and component readiness
PUT /admin/configUpdate global platform configuration
GET /admin/auditRetrieve platform-level audit log entries

Example

{
"method": "POST",
"path": "/admin/tenants",
"body": {
"name": "acme-corp",
"plan": "enterprise",
"adminEmail": "admin@acme.example"
}
}