Tenant API Reference
The Tenant Service exposes REST APIs for the complete tenant lifecycle, including creation, provisioning, migration, branding, resource quotas, privacy, Helm release management, and deployment tracking. All endpoints are served on port 8082 under the /api/v1 prefix.
Base URL
https://:hostname/api/v1Endpoint Groups
| Group | Base Path | Description |
|---|---|---|
| Tenant Endpoints | /api/v1/tenants | CRUD, tier upgrades, suspend/activate |
| Provisioning Endpoints | /api/v1/tenants/:tenantId/provisioning | Status, retry, rollback, SSE streaming |
| Migration Endpoints | /api/v1/tenants/:tenantId/migrations | Region/cluster migration lifecycle |
| Branding Endpoints | /api/v1/tenants/:tenantId/branding | Logo, colors, themes, custom CSS |
| Resource Endpoints | /api/v1/tenants/:tenantId/quotas | Quota management, usage tracking |
| Privacy Endpoints | /api/v1/privacy | Data classification, sensitivity levels |
| Helm Endpoints | /api/v1/helm/releases | Helm release lifecycle management |
| Deployment Endpoints | /api/v1/platform/deployments | Platform version and deployment tracking |
Common Headers
| Header | Required | Description |
|---|---|---|
X-Tenant-ID | Some endpoints | UUID of the target tenant |
X-User-ID | Some endpoints | UUID of the acting user (for audit) |
Content-Type | All POST/PUT | Always application/json |
Pagination
Paginated endpoints use Spring Data parameters (page, size, sort). The sortBy and sortDir parameters are also supported on tenant listing endpoints.