Command reference
deployments budget
Organization, project, environment, and workspace spend budgets
| Command | Summary |
|---|---|
deployments budget list | List spend budgets |
deployments budget create | Create a spend budget |
deployments budget show | Show a spend budget |
deployments budget update | Rename, resize, pause, or resume a spend budget |
deployments budget archive | Archive a spend budget |
deployments budget periods | List a budget's periods with spend |
deployments budget list
List spend budgets.
deployments budget list- Calls
GET /v1/budgets(SDKlistBudgets). - Needs an organization:
--orgor the saved context. - Paginated.
--page-sizesets the page size; pass the returned cursor as--cursorfor the next page.
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
--cursor | string (cursor) | Pagination cursor | ||
--page-size | string (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(SDKcreateBudget). - Needs an organization:
--orgor the saved context. - Sends an idempotency key. The CLI generates one per run; pass
--idempotency-keyto retry safely.
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
--name | string | yes | Budget name | |
--scope | string | yes | Budget scope (organization, project, environment, workspace) | |
--project-id | string | Project the budget governs | ||
--environment-id | string | Environment the budget or its workspace governs | ||
--workspace-id | string | Workspace the budget governs | ||
--period | string | yes | Budget period (daily, monthly, quarterly, yearly) | |
--amount-usd-micros | string (number) | yes | Budget amount in USD micros | |
--thresholds | string (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>- Calls
GET /v1/budgets/{id}(SDKgetBudget). - Needs an organization:
--orgor the saved context.
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
<id> | positional | yes | Resource 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}(SDKupdateBudget). - Needs an organization:
--orgor the saved context. - Sends an idempotency key. The CLI generates one per run; pass
--idempotency-keyto retry safely.
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
<id> | positional | yes | Resource ID | |
--name | string | Budget name | ||
--amount-usd-micros | string (number) | Budget amount in USD micros | ||
--status | string | Budget status (active, paused) | ||
--thresholds | string (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}(SDKarchiveBudget). - Needs an organization:
--orgor the saved context. - Destructive. Live runs ask for confirmation; pass
--yesin scripts or with--json. - Sends an idempotency key. The CLI generates one per run; pass
--idempotency-keyto retry safely.
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
<id> | positional | yes | Resource 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(SDKlistBudgetPeriods). - Needs an organization:
--orgor the saved context. - Paginated.
--page-sizesets the page size; pass the returned cursor as--cursorfor the next page.
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
--cursor | string (cursor) | Pagination cursor | ||
--page-size | string (number) | Page size | ||
<id> | positional | yes | Resource ID |
Also accepts the global flags.