hooks:set-enabled
Enable or disable one hook. A disabled hook is kept but queues no new runs, and a run of it that is still queued when the worker picks it up does not start: it ends as `canceled`, with an error message that names the hook. Runs already running are not interrupted. Enabling again does not revive a canceled run; the next matching event queues a new one. The run history stays. Needs write access to the owner node.
Reference for flywheel hooks:set-enabled.
Command Group
Hooks Commands
Summary
Enable or disable one hook. A disabled hook is kept but queues no new runs, and a run of it that is still queued when the worker picks it up does not start: it ends as canceled, with an error message that names the hook. Runs already running are not interrupted. Enabling again does not revive a canceled run; the next matching event queues a new one. The run history stays. Needs write access to the owner node.
Effect
changes data
Usage
flywheel hooks:set-enabled <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). | ||
--hook_id | string | Hook on owner_node_id, from hook_id in hooks:list or the create result. Unknown or on another owner node: 404, except as the hooks:runs:list filter, where no match returns no runs (omitted: runs of every hook). | ||
--enabled | true to enable, false to disable. |
Optional flags
| Flag | Value | Default | Choices | Description |
|---|---|---|---|---|
--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
Disable one hook.
flywheel hooks:set-enabled --owner_node_id n_owner --hook_id hk_1 --enabled=falseOutput
Default format: json.
| Field | Type |
|---|---|
hook | object |
hooks:secrets:update
Replace a hook secret's value and bump its `version`. The old value cannot be retrieved afterwards. Needs write access to the owner node.
hooks:update
Update one hook; only the flags you pass change (at least one is required). A supplied --workflow_yaml replaces the old workflow entirely, nothing is merged. Enabling or disabling is a separate command: `hooks:set-enabled`. Needs write access to the owner node.