Provisioning

Deprovision a tenant or workspace

Tear down a tenant or single workspace. Supports two auth modes: admin (set tenantId in the body to deprovision any tenant) or tenant self-deprovision (authenticate with a tenant API key carrying tenant:admin; tenantId is derived from the auth context). Requires tenant:admin. Used by the Shopify app on app uninstall.

post/provision/deprovision

Request

  • Base URL: https://api.savanto.ai
  • URL: https://api.savanto.ai/provision/deprovision
  • Auth: HTTP bearer

Request body

tenantIdstring

Required when authenticated as admin. Ignored when authenticated with a tenant API key (tenant:admin required) — the tenant is derived from the auth context.

siteUrlstring

If provided, only this workspace is removed. Omit to fully deprovision the tenant (used by the Shopify app on uninstall).

purgeDataboolean

When true, hard-deletes indexed data for the tenant/workspace.

Response

Tenant deprovisioned

object'deprovision' required
requestIdstring required

Changes

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