Suspend tenant

POST/v1/tenants/{tenantId}/suspendv3.0.0-next.9

Fail the tenant closed: refuse every tenant JWT, doc JWT, and share exchange.

Instantly reversible with resume. The API token is exempt, so a suspended tenant can still be inspected, exported, resumed, or deleted.

Self-hosted surface. On managed CloudPDF this is operated by the platform — your account is already a tenant. Start at Tenant documents.

Authentication#

API token

The deployment's static root credential (CLOUDPDF_API_AUTH_TOKENS), valid on every surface.

Parameters#

tenantIdpathstringrequired

Request body#

application/jsonTenantsSuspendRequest

reasonstring

A complete body with every required field. Strings stand in for your own values.

{
  "reason": "reason"
}

SDK examples#

The selected SDK is remembered across the API reference. Values are examples; replace them with identifiers and input from your application.

import { CloudPDFClient } from "@cloudpdf/sdk";

const client = new CloudPDFClient({
  baseUrl: "https://yourhost.com/path/to/api",
  token: "<token>",
});

await client.tenants.suspend({
  tenantId: "tenantId"
});

Responses#

204No content

No response body.

404Not found

application/jsonTenantsSuspendResponse

errorobject

codestring

messagestring

defaultError

application/jsonAdminErrorPayload

errorobject

codestring

messagestring