From 67d6a43df6932219c30ab0ad714d79f4b0c1d7d4 Mon Sep 17 00:00:00 2001 From: Marcus Efraimsson Date: Wed, 28 Aug 2019 13:26:03 +0200 Subject: [PATCH] Docs: Document LDAP config reload in admin http api (#18739) Fixes #17221 --- docs/sources/http_api/admin.md | 29 ++++++++++++++++++++++++++++- 1 file changed, 28 insertions(+), 1 deletion(-) diff --git a/docs/sources/http_api/admin.md b/docs/sources/http_api/admin.md index 599244ce3b0..2f9e4adf702 100644 --- a/docs/sources/http_api/admin.md +++ b/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" +} +```