Browse Source

Merge branch 'docs-4.1'

bergquist 9 years ago
parent
commit
6518a0f765
2 changed files with 47 additions and 0 deletions
  1. 30 0
      docs/sources/administration/cli.md
  2. 17 0
      docs/sources/http_api/admin.md

+ 30 - 0
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 ...`

+ 17 - 0
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}