Deployments.ai Docs
Command reference

deployments budget

Organization, project, environment, and workspace spend budgets

CommandSummary
deployments budget listList spend budgets
deployments budget createCreate a spend budget
deployments budget showShow a spend budget
deployments budget updateRename, resize, pause, or resume a spend budget
deployments budget archiveArchive a spend budget
deployments budget periodsList a budget's periods with spend

deployments budget list

List spend budgets.

deployments budget list
  • Calls GET /v1/budgets (SDK listBudgets).
  • Needs an organization: --org or the saved context.
  • Paginated. --page-size sets the page size; pass the returned cursor as --cursor for the next page.
FlagTypeRequiredDefaultDescription
--cursorstring (cursor)Pagination cursor
--page-sizestring (number)Page size

Also accepts the global flags.

deployments budget create

Create a spend budget.

deployments budget create --name <name> --scope <scope> --period <period> --amount-usd-micros <number>
  • Calls POST /v1/budgets (SDK createBudget).
  • Needs an organization: --org or the saved context.
  • Sends an idempotency key. The CLI generates one per run; pass --idempotency-key to retry safely.
FlagTypeRequiredDefaultDescription
--namestringyesBudget name
--scopestringyesBudget scope (organization, project, environment, workspace)
--project-idstringProject the budget governs
--environment-idstringEnvironment the budget or its workspace governs
--workspace-idstringWorkspace the budget governs
--periodstringyesBudget period (daily, monthly, quarterly, yearly)
--amount-usd-microsstring (number)yesBudget amount in USD micros
--thresholdsstring (json)Alert thresholds as a JSON array of ascending percents, e.g. [50,80,100]

Also accepts the global flags.

deployments budget show

Show a spend budget.

deployments budget show <id>
FlagTypeRequiredDefaultDescription
<id>positionalyesResource ID

Also accepts the global flags.

deployments budget update

Rename, resize, pause, or resume a spend budget.

deployments budget update <id>
  • Calls PATCH /v1/budgets/{id} (SDK updateBudget).
  • Needs an organization: --org or the saved context.
  • Sends an idempotency key. The CLI generates one per run; pass --idempotency-key to retry safely.
FlagTypeRequiredDefaultDescription
<id>positionalyesResource ID
--namestringBudget name
--amount-usd-microsstring (number)Budget amount in USD micros
--statusstringBudget status (active, paused)
--thresholdsstring (json)Alert thresholds as a JSON array of ascending percents, e.g. [50,80,100]

Also accepts the global flags.

deployments budget archive

Archive a spend budget.

deployments budget archive <id>
  • Calls DELETE /v1/budgets/{id} (SDK archiveBudget).
  • Needs an organization: --org or the saved context.
  • Destructive. Live runs ask for confirmation; pass --yes in scripts or with --json.
  • Sends an idempotency key. The CLI generates one per run; pass --idempotency-key to retry safely.
FlagTypeRequiredDefaultDescription
<id>positionalyesResource ID

Also accepts the global flags.

deployments budget periods

List a budget's periods with spend.

deployments budget periods <id>
  • Calls GET /v1/budgets/{id}/periods (SDK listBudgetPeriods).
  • Needs an organization: --org or the saved context.
  • Paginated. --page-size sets the page size; pass the returned cursor as --cursor for the next page.
FlagTypeRequiredDefaultDescription
--cursorstring (cursor)Pagination cursor
--page-sizestring (number)Page size
<id>positionalyesResource ID

Also accepts the global flags.

On this page