# TENANT.SUSPEND

> Mark a tenant as suspended in the tenant registry.

URL: https://docs.hotkv.com/commands/tenant-suspend/

```
TENANT.SUSPEND id
```

- Group: Tenancy
- Complexity: O(1)
- HotKV Cloud: Scale plan
- On-Premise: requires the multi-tenancy license feature

`TENANT.SUSPEND` sets a tenant's state to `suspended` on every node and
records when it happened. [TENANT.INFO](https://docs.hotkv.com/commands/tenant-info/index.md) shows the
state, and [TENANT.RESUME](https://docs.hotkv.com/commands/tenant-resume/index.md) sets it back to
`active`. Suspending records a state for your own tooling; it does not block
the commands of users bound to the tenant. To lock a tenant's users out,
turn them off with [ACL SETUSER](https://docs.hotkv.com/commands/acl-setuser/index.md) `off`.

## Return value

Simple string `OK` in RESP2 and RESP3, or one of these errors:

| Case | Error |
| --- | --- |
| No such tenant | `ERR tenant not found or already suspended` |
| No license that includes `multi-tenancy` | `NOLICENSE multi-tenancy requires a HotKV license. Contact sales@hotkv.com` |

Suspending a tenant that is already suspended replies `OK` and records the
new time.

## Examples

```
127.0.0.1:6379> TENANT.SUSPEND acme
OK
127.0.0.1:6379> TENANT.SUSPEND nosuch
(error) ERR tenant not found or already suspended
```

## Compatibility

HotKV-only command.

## See also

[TENANT.RESUME](https://docs.hotkv.com/commands/tenant-resume/index.md), [TENANT.INFO](https://docs.hotkv.com/commands/tenant-info/index.md)