Admin Reference

Tenant administration endpoints not covered in other reference pages.

Base path: /api/v1/admin/

All endpoints require tenant:admin or higher.

Cross-reference#

The main admin surface is distributed across reference pages:

User and group management — Users and Groups Reference
Quota management — Quotas Reference
Legal hold, retention, DLP, audit — Enterprise Reference
Connectors — Connectors Reference
Vectorization policies — Enterprise Reference

This page covers miscellaneous admin endpoints.

Tenant management#

GET /api/v1/admin/tenant#

Caller's tenant metadata.

Response:

json
{
  "id": "tnt_01J3A",
  "partner_id": "prt_01J3P",
  "name": "Contoso",
  "display_name": "Contoso, Inc.",
  "status": "active",
  "created_at": "2026-01-01T00:00:00Z",
  "settings": {
    "max_file_size_bytes": 5368709120,
    "default_share_quota_bytes": null,
    "trash_retention_days": 30,
    "version_retention_days": 365,
    "vectorization_enabled": true,
    "require_mfa": false
  }
}

PATCH /api/v1/admin/tenant#

Update settings.

Body: Any settings field from the response.

Partner-level endpoints#

Require partner:admin.

GET /api/v1/admin/partners/{partner_id}/tenants#

List tenants in a partner.

POST /api/v1/admin/partners/{partner_id}/tenants#

Create a new tenant. Returns 201.

Platform status#

Available to authenticated users.

GET /api/v1/config#

Server configuration. No auth.

Response:

json
{
  "version": "0.1.0",
  "features": {
    "semantic_search": true,
    "external_sharing": true,
    "smb_connector": true,
    "sharepoint_connector": true
  },
  "limits": {
    "max_file_size_bytes": 5368709120,
    "max_upload_chunk_size_bytes": 5242880
  }
}

GET /api/v1/health#

Liveness. No auth.

Response: {"status": "healthy", "version": "0.1.0"}.

GET /api/v1/ready#

Readiness. No auth.

Response: {"status": "ready", "checks": {"database": true, "redis": true, "storage": true, "scaikey": true, "weaviate": true}}.

ScaiKey webhook#

POST /api/v1/webhooks/scaikey#

Receives webhooks from ScaiKey. Authenticated via ScaiKey's signature header (X-ScaiKey-Signature), not a bearer token.

Events: user.created, user.updated, user.deleted, group.created, group.updated, group.deleted.

Body: ScaiKey event envelope — see ScaiKey documentation.

Responses: 200 on success, 401 on signature mismatch, 4xx on unsupported event.