Register a Community SaaS tenant (hosted deployment only)

Creates a free-tier tenant on the hosted Community SaaS deployment and returns its credentials once. Mounted only under DEPLOYMENT_MODE=community-saas; every other deployment answers 404. Not authenticated: it is the bootstrap that creates the credential every other route needs. Limited to 5 registrations per client IP per hour.

EVERY FIELD IS OPTIONAL (#4249 row 5764325123). {}, an empty body and no body register an unlabelled tenant with no email; the Go and Java SDKs' RegisterTry("") send exactly {}. A field the route does not know is ignored. Every refusal below is decided before anything is written, and discloses no credential.

post/api/v1/register

Request

Base URL
https://agent.getaxonflow.com
Auth
none required
TypeScript
https://skmtc.dev/getaxonflow/apis/axonflow-agent-api/docs/api/v1/register/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

labelstring

An operator-readable name for the tenant.

emailstring email

Binds the tenant to this address for the free recovery flow (/api/v1/recover). At most 3 active tenants per email.

internal_tenant_id_prefixstring

AxonFlow's own internal callers only: one of a fixed allowlist of axonflow-internal-* prefixes. Any other value is refused 400.

Response

The tenant was created; the secret is shown only this once.

tenant_idstring

secretstring

secret_prefixstring

expires_atstring date-time

endpointstring

notestring

Example response

{
  "tenant_id": "cs_3f0c2a9e-1b7d-4c5e-9a41-6d2f8e0b7c13"
}

Changes

No recorded changes to this operation across all 1 revision of this API.