Skip to main content

Tenants API

Tenants are the top-level isolation boundary in Steward. Each tenant has its own agents, secrets, policies, and API key.

Create Tenant

Auth: Varies (platform key for platform routes, or self-registration via SIWE) Request Body:
Tenant-level defaultPolicies are retired. Supplying that field returns HTTP 410 because the historical implementation was process-local and could diverge across replicas or disappear after restart. Configure durable policies for each agent through the Policies API. Response:
When creating via the platform API (POST /platform/tenants), the API key is auto-generated and returned once in the response. Store it securely — it cannot be retrieved again.

Get Tenant

Auth: Tenant API key Response:

Retired Legacy Update

The historical update route remains only as an explicit fail-closed migration boundary. It performs no mutation and returns HTTP 410 for both webhookUrl and defaultPolicies payloads.
Auth: Tenant owner/admin session with recent MFA Request Body:
Response:
Use /policies and the agent policy-assignment routes for durable policy authority. The SDK exposes those supported policy operations directly; it does not expose this retired legacy route. The generated OpenAPI contract likewise omits the retired route.

Webhook Migration and Events

Create signed webhook endpoints with POST /webhooks. The response returns the endpoint secret exactly once; store it in the receiver and use it to verify deliveries. Historical tenant webhookUrl values are inert and are not silently backfilled with an undisclosed random secret. When configured through /webhooks, Steward dispatches HTTP POST requests for: Webhook payload:

Platform Tenant Management

These endpoints are available via the platform API (/platform/tenants) and require a platform key.
Platform user provisioning, lookup, tenant user search, and wallet external ID assignment are documented separately in Platform Users.

List All Tenants

Get Tenant with Agent Count

Returns tenant details plus an agentCount field.

Create Tenant (Platform)

Auto-generates an API key. The raw key is returned once:

Delete Tenant

Deleting a tenant cascades to all agents, wallets, policies, and transactions. This is permanent.

Retired Tenant Default Policy Route

This compatibility route returns HTTP 410 and performs no write. Tenant-wide process-local defaults are not policy authority. Use PUT /agents/:agentId/policies to persist the complete policy set for each agent instead.

Platform Stats

Auth: Platform key Response: