NAnace
tenants

delete_tenant

Changed on

Disable the tenant and keep its data (default), or with purge=true delete all of it. Cost class: write.

A disabled tenant is re-enabled with PUT and disabled: false. A purge cannot be undone: the tenant is disabled at once, its jobs are cancelled, and every workspace, file, result, cache entry and key is deleted. Only the content-free billing record (job ids, kinds, timestamps, units, credits) is kept. A purge already queued or running is returned as is; one that failed or ended unverified is started again. Once a purge has verified clean the external_ref no longer resolves, so a repeat of this call answers tenant_not_found and a later PUT creates a new, empty tenant.

delete/v1/tenants/{external_ref}

Request

Path parameters

external_refstring required

The partner's own reference for the tenant, such as its account id.

Query parameters

purgeboolean

True permanently deletes the tenant's data instead of disabling it. Answers 202 with a tenant_purge job to poll on GET /v1/jobs/{job_id} without X-NDI-Tenant.

Response

Successful Response

OR

Changes

  • d002a3589a67Revision changes
    • info

      added the optional property / to the response with the status

    • info

      added the optional property to the response with the status