grafana-util docs

grafana-util-dashboard-edit-live.1

Browser-readable rendering of a generated roff manpage.

This page renders the generated roff manpage into readable HTML for browser use. For richer per-subcommand detail, prefer the command-reference pages.

NAME

grafana-util-dashboard-edit-live - Fetch one live dashboard into an external editor with a safe local-draft default.

SYNOPSIS

grafana-util dashboard edit live [OPTIONS]

DESCRIPTION

Fetch one live dashboard into an external editor with a safe local-draft default.

Use this when Grafana already has the closest source dashboard and you want to edit that payload directly, but you do not want the default path to write straight back to Grafana.

COMMON OPTIONS

--dashboard-uid
live Grafana dashboard UID to edit.
--output
local draft path to write after editing. When omitted, the default is ./<uid>.edited.json.
--apply-live
write the edited payload back to Grafana instead of writing a local draft.
--yes
required with --apply-live because it mutates live Grafana.
--message
revision message used when --apply-live writes back to Grafana.
--profile, --url, --token, --basic-user, --basic-password
live Grafana connection settings.

EXAMPLES

Fetch one live dashboard into an external editor with a safe local-draft default.

grafana-util dashboard edit-live --profile prod --dashboard-uid cpu-main --output ./drafts/cpu-main.edited.json

SEE ALSO

grafana-util(1)