SMsmolmachines
plans

Create a plan.

Changed on

Creates a quota/rate/budget plan tenants can be assigned to. Requires the admin scope.

post/v1/plans

Request

Request body

allowAlwaysOnboolean

May keep a published-port machine running instead of scaling to zero.

budgetPolicystring
freeCreditMicrosinteger
idstring nullable
isDefaultboolean
maxConcurrentMachinesinteger
maxCpusinteger
maxDiskGbinteger nullable

Largest disk (GB) one machine may request; omitted = platform maximum.

maxEgressGbinteger nullable
maxGroupsinteger
maxMachinesinteger
maxMemoryMbinteger
monthlyBudgetMicrosinteger nullable
monthlyFeeMicrosinteger

Flat recurring platform fee (micros per period); 0 = usage-only plan.

namestring required
rateBaseHourMicrosinteger
rateCpuHourMicrosinteger
rateDiskGbHourMicrosinteger
rateEgressGbMicrosinteger
rateExecMicrosinteger
rateMemoryGbHourMicrosinteger

Response

Plan created

allowAlwaysOnboolean required
budgetPolicystring required
createdAtstring required
freeCreditMicrosinteger

Recurring free credit applied to each billing period, in micros (e.g. 5_000_000 = $5/month free). Discount applies after volume tiers.

idstring required
isDefaultboolean required
maxConcurrentMachinesinteger required
maxCpusinteger required
maxDiskGbinteger nullable

Largest disk (GB) one machine may request; null = platform maximum.

maxEgressGbinteger nullable
maxGroupsinteger required
maxMachinesinteger required
maxMemoryMbinteger required
monthlyBudgetMicrosinteger nullable
monthlyFeeMicrosinteger required

Flat recurring platform fee (micros per period); 0 = usage-only plan.

namestring required
rateBaseHourMicrosinteger

Per-machine-alive-hour "slot" fee in micros (e.g. 40_000 = $0.04/hr). Prices the held VM slot on top of consumed CPU/RAM — not allocated resources.

rateCpuHourMicrosinteger required
rateDiskGbHourMicrosinteger
rateEgressGbMicrosinteger
rateExecMicrosinteger required
rateMemoryGbHourMicrosinteger required
selfServeboolean

Whether a tenant may switch itself onto this plan. Operator-only tiers are false and never appear in the self-serve list.

Changes

  • bc31fc04a568Revision changes
    • breaking

      removed the required property from the response with the status

    • warning

      removed the request property

    • 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 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 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

    • 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

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status