Delete a Tenant

Deleting a tenant through the API does not delete the tenant's data. Instead, it marks the tenant as deleted. The tenant will no longer be able to access the database, but the data will still be available in the database.

Mark a tenant as deleted with a DELETE request.

Delete Tenant Request

cURL

DELETE- /workspaces/:workspaceSlug/databases/:databaseName/tenants/:tenantId

curl --location --request DELETE 'https://api.thenile.dev/workspaces/<string>/databases/<string>/tenants/<string>' \
--header 'Authorization: Bearer <string>'

When a tenant is successfully marked as deleted, a response with status code 204 is returned.

Delete Tenant Response

204