tenants

Restore Tenant

Restore a suspended tenant: scale it back up from zero replicas.

Any member of the tenant may restore it, not only the owner — unlike deletion. Restoring is non-destructive and a suspended shared workspace is unusable for everyone in it, so requiring the owner would strand members whose owner is away.

Returns as soon as the control plane accepts the request. Restoring is a cold start, so the client should poll GET /{tenant_id}/status until it reports healthy rather than assuming the tenant is ready on return.

Response

{"tenant_id": str, "status": "restoring"}

Error Codes

  • 403 Forbidden: user is not a member of this tenant
  • 404 Not Found: no Tenant CR exists for this tenant
  • 502 Bad Gateway: the control plane rejected or could not serve the request
post/api/v1/tenants/{tenant_id}/restore

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.