ScaleBox Docs

Budget Commands

Reference for account budget, budget status, and budget message commands.

Reference for scalebox-cli budget commands.

All commands on this page also accept --compact for one-line JSON output. Budget commands are account-level operations.

Budget CRUD

  • budget show: show the current account budget, or null.
  • budget create: create a budget with required --amount.
  • budget update: update one or more budget fields.
  • budget delete: delete the current budget.
  • budget status: show budget status and usage.

Create/update flags:

  • --amount
  • --limit-type soft|hard
  • --emails as a comma-separated list
  • --thresholds-json as a JSON array
  • --inactive on budget update to deactivate the budget
scalebox-cli budget show
scalebox-cli budget create --amount 1000 --limit-type soft --emails ops@example.com --thresholds-json '[50,80,100]'
scalebox-cli budget update --amount 1500 --inactive
scalebox-cli budget status
scalebox-cli budget delete

budget messages

List budget notification archive entries. Supported flags: --page, --page-size.

scalebox-cli budget messages --page 1 --page-size 20

Canonical paginated JSON:

{
  "messages": [],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 0,
    "total_pages": 0,
    "offset": 0
  }
}

On this page