approval-sessions:heartbeat
Extend an existing approval session to --ttl_seconds from now (at least 60). Without --session_id, open a new session first, then refresh it. An unknown, someone else's or expired session fails. Returns `approval_session` with `session_id`, `status`, `last_heartbeat_at`, `expires_at`, `user_id`, `created_at` and `updated_at`, plus `opened_session_id` when opened. A call sooner than --min_touch_interval_seconds after the last one returns the session unchanged.
Reference for flywheel approval-sessions:heartbeat.
Command Group
Approvals & Budgets Commands
Summary
Extend an existing approval session to --ttl_seconds from now (at least 60). Without --session_id, open a new session first, then refresh it. An unknown, someone else's or expired session fails. Returns approval_session with session_id, status, last_heartbeat_at, expires_at, user_id, created_at and updated_at, plus opened_session_id when opened. A call sooner than --min_touch_interval_seconds after the last one returns the session unchanged.
Effect
changes data
Usage
flywheel approval-sessions:heartbeat [FLAGS]Required flags
None.
Optional flags
| Flag | Value | Default | Choices | Description |
|---|---|---|---|---|
--session_id | string | approval_session.session_id from approval-sessions:heartbeat or approval-sessions:list. Unknown or not yours: error. Omitted: a new session is opened first, and its ID is returned as opened_session_id. | ||
--ttl_seconds | integer | Seconds the session stays active from this call. Under 60 is raised to 60; no maximum. Omitted: the server default (1800 unless the server sets another). | ||
--min_touch_interval_seconds | integer | Seconds that must pass since the last refresh before this call extends the session; a sooner call returns it unchanged. 0 always extends. Omitted: the server default (15). | ||
--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
Heartbeat.
flywheel approval-sessions:heartbeatOutput
Default format: json.
| Field | Type |
|---|---|
opened_session_id (optional) | string | null |
approval_session | object | null |
approval-sessions:expire
Mark an approval session expired. Grants, leases and campaign budgets are untouched: machines keep running and keep billing until you release them with compute:release. Returns `approval_session` (now expired), `reason` (echoed back, not stored) and two lists, `expired_compute_grant_ids` and `released_lease_ids`, which are always empty (kept so older callers still find the fields).
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.