SMsmolmachines
tenants

Update a tenant.

Changed on

Patches a tenant's plan, limits, or metadata. Requires the admin scope.

patch/v1/tenants/{id}

Request

Path parameters

idstring required

Tenant id

Request body

externalBillingIdstring nullable
freeCreditMicrosinteger nullable

Per-tenant free-credit override (micros). Present → this tenant's monthly free allotment is set to exactly this, overriding its plan's. Absent → unchanged (still falls back to the plan). Admin-only.

maxCpusinteger nullable

Per-machine size overrides for this tenant (each null = leave as is). They sit above the plan's ceilings, for a deal that needs bigger machines without a new plan.

maxDiskGbinteger nullable
maxMemoryMbinteger nullable
planIdstring nullable
statusstring nullable

Response

Updated

createdAtstring required
externalBillingIdstring nullable
idstring required
maxCpusinteger nullable
maxDiskGbinteger nullable

Per-tenant override of the plan's per-machine disk ceiling (GB).

maxGroupsinteger nullable
maxMemoryMbinteger nullable
maxSandboxPoolsinteger nullable
namestring required
planIdstring nullable
statusstring required
updatedAtstring nullable

Changes

  • bc31fc04a568Revision changes
    • warning

      removed the optional property from the response with the status

    • info

      the endpoint scheme security ApiKeyAuth was added to the API

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status