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.
Reference for flywheel hooks:delete.
Command Group
Hooks Commands
Summary
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.
Effect
DESTRUCTIVE: deletes, overwrites or revokes something
Usage
flywheel hooks:delete <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). |
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
Delete one hook.
flywheel hooks:delete --owner_node_id n_owner --hook_id hk_1Output
Default format: json.
| Field | Type |
|---|---|
deleted | boolean |
hooks:create
Create one hook on an owner node. Creating a hook runs nothing: it is stored, and while enabled it runs later and automatically, as queued runs, when an `artifact.finalized` (an artifact upload finalized) or `node.published` (a node made public with submission artifacts) event matches its scope. A workflow is a restricted set of steps (HTTP requests and polling, JSON extraction, artifact load and upsert, adding tags) and can call outside services, using secrets as `${{ secrets.NAME }}`. Needs write access to the owner node.
hooks:list
List the hooks configured on an owner node (scope, workflow, enabled state). Needs read access.