campaign-budgets:create
Fund a campaign compute budget that participants on a root's graph draw from through their own grants. It needs `hard_cap_cents` of credit headroom: your balance minus what your other active campaign budgets still have uncommitted. Without it the call fails with `Campaign budget commitment needs N cents, but only M cents are available.` Returns `budget` (including `compute_budget_id`). Only the campaign's owner or an admin may create one.
Reference for flywheel campaign-budgets:create.
Command Group
Approvals & Budgets Commands
Summary
Fund a campaign compute budget that participants on a root's graph draw from through their own grants. It needs hard_cap_cents of credit headroom: your balance minus what your other active campaign budgets still have uncommitted. Without it the call fails with Campaign budget commitment needs N cents, but only M cents are available. Returns budget (including compute_budget_id). Only the campaign's owner or an admin may create one.
Effect
changes data
Usage
flywheel campaign-budgets:create <FLAGS>Required flags
| Flag | Value | Default | Choices | Description |
|---|---|---|---|---|
--root_node_id | string | UUID of a root node (no parents) from roots in graph:get. Tag commands refuse a non-root (400); budget commands use a descendant's root. | ||
--hard_cap_cents | integer | Most the whole budget may spend, in cents; above 0. Counted against your credits when you create it. |
Optional flags
| Flag | Value | Default | Choices | Description |
|---|---|---|---|---|
--per_user_hard_cap_cents | integer | Most any one participant may spend from this budget, in cents; above 0 and at most --hard_cap_cents. Omitted: no per-person limit. | ||
--name | string | Label for the budget; surrounding whitespace is dropped and a blank one is ignored. | ||
--description | string | Longer note about the budget; surrounding whitespace is dropped and a blank one is ignored. | ||
--format | FORMAT | json, tsv, csv, table | Output format for command results. | |
--env | PROFILE | Select a CLI profile; unconfigured default requires FLYWHEEL_BASE_URL. | ||
--out | PATH | Write output to a file path, or use - for stdout. | ||
--open | Open browser-bound URLs when supported. | |||
--no-retry | Disable transient-error retries. | |||
--retry-max | N | Maximum transient-error retry attempts. | ||
--wait | Block on async operations until a terminal state is reached. | |||
--wait-timeout | SECONDS | 600 | Seconds to wait for --wait before timing out. Defaults to 600. | |
--allow-self | Allow mutating the currently active credential. | |||
--timeout | SECONDS | Set the per-request timeout budget in seconds. | ||
--idempotency-key | KEY | Reuse an Idempotency-Key so ambiguous write failures can be retried with the same key. | ||
--force | Force safety-gated operations where supported. | |||
--yes | Confirm forced compute:release-all --force. Other runtime commands do not read --yes. | |||
--debug | Print structured request debugging with secrets masked. | |||
--verbose | Print verbose progress for long-running operations. | |||
-h, --help | Show this help. |
Examples
Create a named budget with a per-participant limit.
flywheel campaign-budgets:create --root_node_id r_root --hard_cap_cents 10000 --per_user_hard_cap_cents 2500 --name "Spring cohort"Output
Default format: json.
| Field | Type |
|---|---|
budget | object |
approval-sessions:list
List your approval sessions, most recently updated first. Returns `approval_sessions`, each with the same session fields as approval-sessions:heartbeat. Use it to find a `session_id`, or sessions left open that you want to expire.
campaign-budgets:list
List the compute budgets funded for a campaign (a graph's root). Only the campaign's owner or an admin may call it. Returns `budgets`, each with `compute_budget_id`, `status` (`active`, `exhausted` or `revoked`), `hard_cap_cents`, `per_user_hard_cap_cents`, `name`, `description`, `spent_cents`, `remaining_cents` and timestamps.