resource
What this page covers
Read a small set of live Grafana resources through a generic read-only query surface.
When to open this page
- Use this when you need a read-only live lookup before a richer workflow exists in dashboard, alert, datasource, access, or change.
Purpose
Read a small set of live Grafana resources through a generic read-only query surface.
When to use
Use this when you need a read-only live lookup before a richer workflow exists in dashboard, alert, datasource, access, or change.
Description
This namespace is intentionally narrower and more generic than the main operator workflows. It exists so you can inspect a few supported live Grafana resource kinds without waiting for a full domain-specific command surface.
Treat it as a read-only utility surface, not as the primary entrypoint for day-to-day mutation work.
Workflow
- Start with
resource describeto see the supported selector patterns and endpoint shape for each kind. - Use
resource kindsto see the currently supported live resource kinds. - Use
resource list <kind>when you need inventory for one kind. - Use
resource get <kind>/<identity>when you need the full live payload for one item.
Supported kinds
dashboardsfoldersdatasourcesalert-rulesorgs
Output
kindssupportstext,table,json, andyamllistsupportstext,table,json, andyamlgetsupportstext,table,json, andyaml
Examples
# Purpose: Describe the supported live resource kinds and selector patterns.
grafana-util resource describe
# Purpose: Show the currently supported generic resource kinds.
grafana-util resource kinds
# Purpose: List live dashboard resources from a local Grafana.
grafana-util resource list dashboards --url http://localhost:3000 --basic-user admin --basic-password admin
# Purpose: Fetch one datasource payload as YAML.
grafana-util resource get datasources/prom-main --profile prod --output-format yaml