tenants

Get Tenant Status Endpoint

Single-shot k8s status for a tenant, backed by the k8s control plane — covers provisioning, readiness, and health, not just the initial provisioning phase. Lets the frontend tell "still provisioning" apart from a genuine failure instead of guessing from how long a direct pod ping has been failing (see wait_for_tenant_instance_provisioning for the equivalent polling loop used synchronously during creation itself).

Response

{"tenant_id": str, "status": "provisioning" | "healthy" | "suspended" | "failed" | "terminating" | "unknown"}

suspended means the tenant is scaled to zero with its data intact. It will not come up on its own — the client should offer a restore action (POST /{tenant_id}/restore) rather than keep polling.

get/api/v1/tenants/{tenant_id}/status

Request

  • Base URL
    https://api.aws.cognee.ai (the document declares no server; this is the origin it was published from)
  • Auth
    API key in header X-Api-Key

Path parameters

tenant_idstring uuid required

Response

Successful Response

unknown required

Changes

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