diff --git a/docs/api/auth.md b/docs/api/auth.md index 4739859..4b27410 100644 --- a/docs/api/auth.md +++ b/docs/api/auth.md @@ -1,5 +1,3 @@ -# API Reference: Authentication - Authentication is required for most API endpoints. The Pi-hole API uses a session-based authentication system. This means that you will not be able to use a static token to authenticate your requests. Instead, you will be given a session ID (SID) that you will have to use. If you didn't set a password for your Pi-hole, you don't have to authenticate your requests. To get a session ID, you will have to send a `POST` request to the `/api/auth` endpoint with a payload containing your password. Note that is also possible to use an application password instead of your regular password, e.g., if you don't want to put your password in your scripts or if you have 2FA enabled for your regular password. One application password can be generated in the web interface on the settings page. diff --git a/docs/api/index.md b/docs/api/index.md index b84d41d..5e2f924 100644 --- a/docs/api/index.md +++ b/docs/api/index.md @@ -1,5 +1,3 @@ -# API Reference: Overview - The Pi-hole API is organized around [REST](http://en.wikipedia.org/wiki/Representational_State_Transfer). Our API has predictable resource-oriented URLs, accepts and returns reliable UTF-8 [JavaScript Object Notation (JSON)-encoded](http://www.json.org/) data for all API responses, and uses standard HTTP response codes and verbs. Most (but not all) endpoints require authentication. API endpoints requiring authentication will fail with code `401 Unauthorized` if no key is supplied. See [API Reference: Authentication](auth.md) for details. diff --git a/mkdocs.yml b/mkdocs.yml index 47a8b7f..eab03d9 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -129,7 +129,7 @@ nav: - 'Group Management': database/domain-database/groups.md - 'Database Recovery': database/domain-database/recovery.md - 'Pi-hole API': - - 'Overview': api/index.md + - 'Pi-hole API': api/index.md - 'Authentication': api/auth.md - 'TLS/SSL': api/tls.md - 'FTLDNS':