Suspend or reactivate a tenant

POST

/admin/tenants/{id}/status

const url = 'http://localhost:3000/admin/tenants/example/status';
const options = {
  method: 'POST',
  headers: {'X-Admin-Key': '<X-Admin-Key>', 'Content-Type': 'application/json'},
  body: '{"status":"active"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url http://localhost:3000/admin/tenants/example/status \
  --header 'Content-Type: application/json' \
  --header 'X-Admin-Key: <X-Admin-Key>' \
  --data '{ "status": "active" }'

Deletes the tenant’s Redis cache keys in the same operation — without that, suspension takes effect up to 60 seconds late (spec §5 step 1).

Authorizations

adminKey

Parameters

Path Parameters

required

string

Request Body^required

application/json

object

status

required

string

Allowed values: active suspended

Responses

200

The tenant, with its new status.