From ba848cffb45c1b2b2543764c7d13499a54211a11 Mon Sep 17 00:00:00 2001 From: bergquist Date: Mon, 12 Dec 2016 13:15:35 +0100 Subject: [PATCH 1/2] docs(cli): add page for the cli --- docs/sources/administration/cli.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 docs/sources/administration/cli.md diff --git a/docs/sources/administration/cli.md b/docs/sources/administration/cli.md new file mode 100644 index 00000000000..99446fb5f1b --- /dev/null +++ b/docs/sources/administration/cli.md @@ -0,0 +1,30 @@ ++++ +title = "Grafana CLI" +description = "Guide to using grafana-cli" +keywords = ["grafana", "cli", "grafana-cli", "command line interface"] +type = "docs" +[menu.docs] +parent = "admin" +weight = 8 ++++ + +# Grafana CLI + +Grafana cli is a small executable that is bundled with grafana server and is suppose to be executed on the same machine as grafana runs. + +## Plugins + +The CLI helps you install, upgrade and manage your plugins on the same machine it CLI is running. You can find more information about how to install and manage your plugins at the [plugin page] ({{< relref "/installation.md" >}}) + +## Admin + +> This feature is only available in grafana 4.1 and above. + +To show all admin commands: +`grafana-cli admin` + +### Reset admin password + +You can reset the password for the admin user using the CLI. + +`grafana-cli admin reset-admin-password ...` From 0c857e0ed8d16c37d4663225ac5958569ffa7463 Mon Sep 17 00:00:00 2001 From: bergquist Date: Mon, 19 Dec 2016 16:45:46 +0100 Subject: [PATCH 2/2] docs(http): adds info about mass pausing alerts --- docs/sources/http_api/admin.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/docs/sources/http_api/admin.md b/docs/sources/http_api/admin.md index 2d15b19454c..fc9b3177e52 100644 --- a/docs/sources/http_api/admin.md +++ b/docs/sources/http_api/admin.md @@ -275,3 +275,20 @@ Change password for specific user Content-Type: application/json {message: "User deleted"} + +## Pause all alerts + +`DELETE /api/admin/pause-all-alerts` + +**Example Request**: + + DELETE /api/admin/pause-all-alerts HTTP/1.1 + Accept: application/json + Content-Type: application/json + +**Example Response**: + + HTTP/1.1 200 + Content-Type: application/json + + {state: "new state", message: "alerts pause/un paused", "alertsAffected": 100}