⚠️

Internal admin API. Tenants are the underlying platform isolation boundary. SDK consumers should use sdk.organizations instead — it exposes the same concept with a simpler, developer-friendly interface.

Tenants

A Tenant is the top-level isolation boundary in cPod. All data, billing, configuration, and access control are scoped to a tenant. Each API key belongs to exactly one tenant, and data never crosses tenant boundaries.

⚠️

Tenant management is restricted to platform administrators. Most application developers interact with a single tenant and do not need these APIs.

Tenant Schema

Field	Type	Required	Description
`id`	`string`	auto	Prefixed ID: `tnt-{ulid}`
`name`	`string`	yes	Human-readable tenant name
`slug`	`string`	yes	URL-safe unique identifier (immutable after creation)
`plan`	`enum`	yes	`free` \| `pro` \| `enterprise`
`status`	`enum`	auto	`active` \| `suspended` \| `pending_deletion`
`settings.maxPods`	`number`	no	Maximum number of concurrent pods
`settings.allowedRegions`	`string[]`	no	Regions where data may reside
`settings.ssoEnabled`	`boolean`	no	Whether SSO is enabled for this tenant
`settings.auditLogsEnabled`	`boolean`	no	Whether audit logging is active
`createdAt`	`string`	auto	ISO 8601 UTC
`updatedAt`	`string`	auto	ISO 8601 UTC

Get the Current Tenant

Retrieve the tenant associated with the current API key.

import { CpodClient } from '@cpod/sdk'
const sdk = CpodClient.fromEnv()
 
const tenant = await sdk.tenants.get('tnt-default')
console.log(tenant.name, tenant.plan, tenant.status)
// → "Acme Corp" "enterprise" "active"

from cpod import CpodClient
sdk = CpodClient.from_env()
 
tenant = await sdk.tenants.get("tnt-default")
print(tenant.name, tenant.plan, tenant.status)
# → "Acme Corp" "enterprise" "active"

import "github.com/cpod-ai/cpod-sdk-go/tenants"
 
client := cpod.New(os.Getenv("CPOD_API_KEY"))
 
tenant, err := client.Tenants.Get(ctx, "tnt-default")
if err != nil {
    log.Fatal(err)
}
fmt.Println(tenant.Name, tenant.Plan, tenant.Status)

List Tenants

List all tenants accessible to the authenticated service account. Regular API keys only see their own tenant.

const result = await sdk.tenants.list({
  plan: 'enterprise',
  status: 'active',
  limit: 50,
})
 
for (const tenant of result.items) {
  console.log(tenant.id, tenant.name, tenant.plan)
}

result = await sdk.tenants.list(plan="enterprise", status="active", limit=50)
 
for tenant in result.items:
    print(tenant.id, tenant.name, tenant.plan)

result, err := client.Tenants.List(ctx, tenants.ListOptions{
    Plan:   "enterprise",
    Status: "active",
    Limit:  50,
})
for _, t := range result.Items {
    fmt.Println(t.ID, t.Name, t.Plan)
}

Update Tenant Settings

Update the name, plan, or settings of a tenant. The slug field is immutable.

const updated = await sdk.tenants.update('tnt-default', {
  name: 'Acme Corporation',
  settings: {
    maxPods: 20,
    ssoEnabled: true,
    auditLogsEnabled: true,
    allowedRegions: ['us-east-1', 'eu-west-1'],
  },
})
console.log(updated.settings.ssoEnabled) // → true

updated = await sdk.tenants.update(
    "tnt-default",
    name="Acme Corporation",
    settings={
        "max_pods": 20,
        "sso_enabled": True,
        "audit_logs_enabled": True,
        "allowed_regions": ["us-east-1", "eu-west-1"],
    },
)
print(updated.settings.sso_enabled)  # → True

updated, err := client.Tenants.Update(ctx, "tnt-default", tenants.UpdateInput{
    Name: "Acme Corporation",
    Settings: &tenants.Settings{
        MaxPods:           20,
        SSOEnabled:        true,
        AuditLogsEnabled:  true,
        AllowedRegions:    []string{"us-east-1", "eu-west-1"},
    },
})
fmt.Println(updated.Settings.SSOEnabled) // → true

Create a Tenant

⚠️

Creating tenants requires a super-admin service account. This operation is not available to standard API keys.

const tenant = await sdk.tenants.create({
  name: 'Beta Corp',
  slug: 'beta-corp',
  plan: 'pro',
  settings: {
    maxPods: 5,
    auditLogsEnabled: true,
  },
})
console.log(tenant.id) // → "tnt-01HXYZ..."

tenant = await sdk.tenants.create(
    name="Beta Corp",
    slug="beta-corp",
    plan="pro",
    settings={
        "max_pods": 5,
        "audit_logs_enabled": True,
    },
)
print(tenant.id)  # → "tnt-01HXYZ..."

tenant, err := client.Tenants.Create(ctx, tenants.CreateInput{
    Name: "Beta Corp",
    Slug: "beta-corp",
    Plan: "pro",
    Settings: &tenants.Settings{
        MaxPods:          5,
        AuditLogsEnabled: true,
    },
})
fmt.Println(tenant.ID) // → "tnt-01HXYZ..."

Overview Organizations