Create tenant

POST/v1/tenantsv3.0.0-next.9

Create a tenant, or confirm it already exists — ensure-style, idempotent.

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.

Request body#

application/jsonTenantsCreateRequestrequired

idstringrequired

namestring

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

{
  "id": "id"
}

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.create({
  id: "id"
});

Responses#

200OK

application/jsonTenantsCreate200Response

tenantobject

idstring

namestring

autoProvisionedboolean

status"active" | "suspended"optional

createdAtnumber

createdboolean

400Bad request

application/jsonTenantsCreate400Response

errorobject

codestring

messagestring

defaultError

application/jsonAdminErrorPayload

errorobject

codestring

messagestring