Переглянути джерело

Docs: Document LDAP config reload in admin http api (#18739)

Fixes #17221
Marcus Efraimsson 6 роки тому
батько
коміт
67d6a43df6
1 змінених файлів з 28 додано та 1 видалено
  1. 28 1
      docs/sources/http_api/admin.md

+ 28 - 1
docs/sources/http_api/admin.md

@@ -466,7 +466,7 @@ Content-Type: application/json
 
 Reloads the provisioning config files for specified type and provision entities again. It won't return
 until the new provisioned entities are already stored in the database. In case of dashboards, it will stop
-polling for changes in dashboard files and then restart it with new configs after returning. 
+polling for changes in dashboard files and then restart it with new configs after returning.
 
 Only works with Basic Authentication (username and password). See [introduction](http://docs.grafana.org/http_api/admin/#admin-api) for an explanation.
 
@@ -488,3 +488,30 @@ Content-Type: application/json
   "message": "Dashboards config reloaded"
 }
 ```
+
+## Reload LDAP configuration
+
+`POST /api/admin/ldap/reload`
+
+Reloads the LDAP configuration.
+
+Only works with Basic Authentication (username and password). See [introduction](http://docs.grafana.org/http_api/admin/#admin-api) for an explanation.
+
+**Example Request**:
+
+```http
+POST /api/admin/ldap/reload HTTP/1.1
+Accept: application/json
+Content-Type: application/json
+```
+
+**Example Response**:
+
+```http
+HTTP/1.1 200
+Content-Type: application/json
+
+{
+  "message": "LDAP config reloaded"
+}
+```