Skip to content

Commit

Permalink
Docs: Document LDAP config reload in admin http api (#18739)
Browse files Browse the repository at this point in the history
Fixes #17221
  • Loading branch information
marefr committed Aug 28, 2019
1 parent c347b64 commit 67d6a43
Showing 1 changed file with 28 additions and 1 deletion.
29 changes: 28 additions & 1 deletion docs/sources/http_api/admin.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -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"
}
```

0 comments on commit 67d6a43

Please sign in to comment.