Grafana CLI

Observability and monitoring platform. Create dashboards, set up alerts, and visualize metrics from any data source.

38 commands

Browse by Topic

Getting Started

Quick setup and installation

3commands

Dashboards

Dashboard management

8commands

Plugins

Plugin management

7commands

Administration

Server admin

7commands

API

REST API

13commands

Install Grafana (macOS)

$ brew install grafana

Install Grafana using Homebrew on macOS

Start Grafana server

$ brew services start grafana

Start Grafana as a background service on macOS

Check Grafana version

$ grafana-server -v

Verify Grafana installation and display server version

Export dashboard

$ curl -s http://localhost:3000/api/dashboards/uid/DASHBOARD_UID -H 'Authorization: Bearer TOKEN' | jq '.dashboard' > dashboard.json

Export dashboard to JSON.

Import dashboard

$ curl -X POST http://localhost:3000/api/dashboards/db -H 'Content-Type: application/json' -H 'Authorization: Bearer TOKEN' -d @dashboard.json

Import dashboard from JSON.

List dashboards

$ curl -s http://localhost:3000/api/search -H 'Authorization: Bearer TOKEN'

List all dashboards.

Delete dashboard

$ curl -X DELETE http://localhost:3000/api/dashboards/uid/DASHBOARD_UID -H 'Authorization: Bearer TOKEN'

Delete a dashboard.

Search dashboards by query

$ curl -s 'http://localhost:3000/api/search?query=cpu' -H 'Authorization: Bearer TOKEN'

Search dashboards by keyword.

Get dashboard versions

$ curl -s http://localhost:3000/api/dashboards/id/1/versions -H 'Authorization: Bearer TOKEN'

List version history of a dashboard.

Get dashboard permissions

$ curl -s http://localhost:3000/api/dashboards/uid/DASHBOARD_UID/permissions -H 'Authorization: Bearer TOKEN'

View dashboard access permissions.

List folders

$ curl -s http://localhost:3000/api/folders -H 'Authorization: Bearer TOKEN'

List all dashboard folders.

Install plugin

$ grafana-cli plugins install grafana-piechart-panel

Install a Grafana plugin.

List installed plugins

$ grafana-cli plugins ls

List installed plugins.

Update plugins

$ grafana-cli plugins update-all

Update all plugins.

Remove plugin

$ grafana-cli plugins remove grafana-piechart-panel

Remove a plugin.

List available plugins

$ grafana-cli plugins list-remote

List available plugins.

Install specific plugin version

$ grafana-cli plugins install grafana-clock-panel 2.1.3

Install a plugin at a specific version.

Check for plugin updates

$ grafana-cli plugins list-versions grafana-piechart-panel

List available versions of a plugin.

Reset admin password

$ grafana-cli admin reset-admin-password newpassword

Reset the admin password.

Generate secret key

$ grafana-cli admin secret-key

Generate a new secret key.

Migrate data

$ grafana-cli admin data-migration

Run data migration.

Check Grafana version

$ grafana-cli --version

Show Grafana CLI version.

Start Grafana server

$ grafana-server --config=/etc/grafana/grafana.ini --homepath=/usr/share/grafana

Start Grafana with custom config.

List users via API

$ curl -s http://localhost:3000/api/users -H 'Authorization: Bearer TOKEN'

List all Grafana users.

Get current org

$ curl -s http://localhost:3000/api/org -H 'Authorization: Bearer TOKEN'

Get current organization details.

Create API key

$ curl -X POST http://localhost:3000/api/auth/keys -H 'Content-Type: application/json' -d '{"name":"mykey","role":"Admin"}' -u admin:admin

Create an API key.

Create datasource

$ curl -X POST http://localhost:3000/api/datasources -H 'Content-Type: application/json' -H 'Authorization: Bearer TOKEN' -d @datasource.json

Create a datasource via API.

Health check

$ curl http://localhost:3000/api/health

Check Grafana health.

Create folder

$ curl -X POST http://localhost:3000/api/folders -H 'Content-Type: application/json' -H 'Authorization: Bearer TOKEN' -d '{"title":"My Folder"}'

Create dashboard folder.

List datasources

$ curl -s http://localhost:3000/api/datasources -H 'Authorization: Bearer TOKEN'

List all configured datasources.

Get datasource by name

$ curl -s http://localhost:3000/api/datasources/name/Prometheus -H 'Authorization: Bearer TOKEN'

Get datasource details by name.

Delete datasource

$ curl -X DELETE http://localhost:3000/api/datasources/1 -H 'Authorization: Bearer TOKEN'

Delete a datasource by ID.

Create annotation

$ curl -X POST http://localhost:3000/api/annotations -H 'Content-Type: application/json' -H 'Authorization: Bearer TOKEN' -d '{"text":"Deployment v1.2","tags":["deploy"]}'

Add annotation to all dashboards.

Create service account

$ curl -X POST http://localhost:3000/api/serviceaccounts -H 'Content-Type: application/json' -H 'Authorization: Bearer TOKEN' -d '{"name":"ci-bot","role":"Editor"}'

Create a service account for automation.

List alert rules

$ curl -s http://localhost:3000/api/v1/provisioning/alert-rules -H 'Authorization: Bearer TOKEN'

List all alert rules via API.

List contact points

$ curl -s http://localhost:3000/api/v1/provisioning/contact-points -H 'Authorization: Bearer TOKEN'

List alert notification contact points.

Test datasource connection

$ curl -X POST http://localhost:3000/api/datasources/proxy/1/api/v1/query -H 'Authorization: Bearer TOKEN' -d 'query=up'

Test a datasource connection via proxy.

Snapshot dashboard

$ curl -X POST http://localhost:3000/api/snapshots -H 'Content-Type: application/json' -H 'Authorization: Bearer TOKEN' -d @snapshot.json

Create a dashboard snapshot.

Discussion

Loading comments...

Grafana CLI

Observability and monitoring platform. Create dashboards, set up alerts, and visualize metrics from any data source.

38 commands

Browse by Topic

Getting Started

Quick setup and installation

3commands

Dashboards

Dashboard management

8commands

Plugins

Plugin management

7commands

Administration

Server admin

7commands

API

REST API

13commands

Install Grafana (macOS)

$ brew install grafana

Install Grafana using Homebrew on macOS

Start Grafana server

$ brew services start grafana

Start Grafana as a background service on macOS

Check Grafana version

$ grafana-server -v

Verify Grafana installation and display server version

Export dashboard

$ curl -s http://localhost:3000/api/dashboards/uid/DASHBOARD_UID -H 'Authorization: Bearer TOKEN' | jq '.dashboard' > dashboard.json

Export dashboard to JSON.

Import dashboard

$ curl -X POST http://localhost:3000/api/dashboards/db -H 'Content-Type: application/json' -H 'Authorization: Bearer TOKEN' -d @dashboard.json

Import dashboard from JSON.

List dashboards

$ curl -s http://localhost:3000/api/search -H 'Authorization: Bearer TOKEN'

List all dashboards.

Delete dashboard

$ curl -X DELETE http://localhost:3000/api/dashboards/uid/DASHBOARD_UID -H 'Authorization: Bearer TOKEN'

Delete a dashboard.

Search dashboards by query

$ curl -s 'http://localhost:3000/api/search?query=cpu' -H 'Authorization: Bearer TOKEN'

Search dashboards by keyword.

Get dashboard versions

$ curl -s http://localhost:3000/api/dashboards/id/1/versions -H 'Authorization: Bearer TOKEN'

List version history of a dashboard.

Get dashboard permissions

$ curl -s http://localhost:3000/api/dashboards/uid/DASHBOARD_UID/permissions -H 'Authorization: Bearer TOKEN'

View dashboard access permissions.

List folders

$ curl -s http://localhost:3000/api/folders -H 'Authorization: Bearer TOKEN'

List all dashboard folders.

Install plugin

$ grafana-cli plugins install grafana-piechart-panel

Install a Grafana plugin.

List installed plugins

$ grafana-cli plugins ls

List installed plugins.

Update plugins

$ grafana-cli plugins update-all

Update all plugins.

Remove plugin

$ grafana-cli plugins remove grafana-piechart-panel

Remove a plugin.

List available plugins

$ grafana-cli plugins list-remote

List available plugins.

Install specific plugin version

$ grafana-cli plugins install grafana-clock-panel 2.1.3

Install a plugin at a specific version.

Check for plugin updates

$ grafana-cli plugins list-versions grafana-piechart-panel

List available versions of a plugin.

Reset admin password

$ grafana-cli admin reset-admin-password newpassword

Reset the admin password.

Generate secret key

$ grafana-cli admin secret-key

Generate a new secret key.

Migrate data

$ grafana-cli admin data-migration

Run data migration.

Check Grafana version

$ grafana-cli --version

Show Grafana CLI version.

Start Grafana server

$ grafana-server --config=/etc/grafana/grafana.ini --homepath=/usr/share/grafana

Start Grafana with custom config.

List users via API

$ curl -s http://localhost:3000/api/users -H 'Authorization: Bearer TOKEN'

List all Grafana users.

Get current org

$ curl -s http://localhost:3000/api/org -H 'Authorization: Bearer TOKEN'

Get current organization details.

Create API key

$ curl -X POST http://localhost:3000/api/auth/keys -H 'Content-Type: application/json' -d '{"name":"mykey","role":"Admin"}' -u admin:admin

Create an API key.

Create datasource

$ curl -X POST http://localhost:3000/api/datasources -H 'Content-Type: application/json' -H 'Authorization: Bearer TOKEN' -d @datasource.json

Create a datasource via API.

Health check

$ curl http://localhost:3000/api/health

Check Grafana health.

Create folder

$ curl -X POST http://localhost:3000/api/folders -H 'Content-Type: application/json' -H 'Authorization: Bearer TOKEN' -d '{"title":"My Folder"}'

Create dashboard folder.

List datasources

$ curl -s http://localhost:3000/api/datasources -H 'Authorization: Bearer TOKEN'

List all configured datasources.

Get datasource by name

$ curl -s http://localhost:3000/api/datasources/name/Prometheus -H 'Authorization: Bearer TOKEN'

Get datasource details by name.

Delete datasource

$ curl -X DELETE http://localhost:3000/api/datasources/1 -H 'Authorization: Bearer TOKEN'

Delete a datasource by ID.

Create annotation

$ curl -X POST http://localhost:3000/api/annotations -H 'Content-Type: application/json' -H 'Authorization: Bearer TOKEN' -d '{"text":"Deployment v1.2","tags":["deploy"]}'

Add annotation to all dashboards.

Create service account

$ curl -X POST http://localhost:3000/api/serviceaccounts -H 'Content-Type: application/json' -H 'Authorization: Bearer TOKEN' -d '{"name":"ci-bot","role":"Editor"}'

Create a service account for automation.

List alert rules

$ curl -s http://localhost:3000/api/v1/provisioning/alert-rules -H 'Authorization: Bearer TOKEN'

List all alert rules via API.

List contact points

$ curl -s http://localhost:3000/api/v1/provisioning/contact-points -H 'Authorization: Bearer TOKEN'

List alert notification contact points.

Test datasource connection

$ curl -X POST http://localhost:3000/api/datasources/proxy/1/api/v1/query -H 'Authorization: Bearer TOKEN' -d 'query=up'

Test a datasource connection via proxy.

Snapshot dashboard

$ curl -X POST http://localhost:3000/api/snapshots -H 'Content-Type: application/json' -H 'Authorization: Bearer TOKEN' -d @snapshot.json

Create a dashboard snapshot.

Discussion

Loading comments...