hooks:list
List the hooks configured on an owner node (scope, workflow, enabled state). Needs read access.
Reference for flywheel hooks:list.
Command Group
Hooks Commands
Summary
List the hooks configured on an owner node (scope, workflow, enabled state). Needs read access.
Effect
read-only
Usage
flywheel hooks:list <FLAGS>Required flags
| Flag | Value | Default | Choices | Description |
|---|---|---|---|---|
--owner_node_id | string | Node owning the hooks and secrets: any node_id, or owner_node_id in hook results. Missing or hidden: 404. Listing hooks or runs needs read access; changes and secret listing need write access (else 403). |
Optional flags
| Flag | Value | Default | Choices | Description |
|---|---|---|---|---|
--include_disabled | Include disabled hooks (omitted: true); pass --include_disabled=false to list only enabled ones. | |||
--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
List all hooks including disabled entries.
flywheel hooks:list --owner_node_id n_owner --include_disabledOutput
Default format: json.
| Field | Type |
|---|---|
hooks | array<object> |
hooks:delete
Delete one hook and its run history (queued, running and finished runs). It cannot be undone. To stop new and queued runs but keep the history, disable it with `hooks:set-enabled`. Needs write access to the owner node.
hooks:runs:list
List runs of hooks on an owner node, newest first (`queued`, `running`, `succeeded`, `failed` or `canceled`; `canceled` is a queued run whose hook was disabled, with the reason in `error_message`), optionally for one hook. Runs are queued automatically when a matching event happens (see `hooks:create`). Returns at most --limit runs (default 100, range 1-200) and has no paging, so it shows recent history only. Needs read access.