mirror of
https://github.com/AdguardTeam/AdGuardHome.git
synced 2025-10-26 11:27:18 +00:00
16fda88899
Merge in DNS/adguard-home from upd-all to master
Squashed commit of the following:
commit 7e0b4435b5df6b8415a3c8a4dbd59d75750e545f
Author: Eugene Burkov <E.Burkov@AdGuard.COM>
Date: Tue Jun 10 15:52:49 2025 +0300
client: upd i18n
commit 5c17d66cf44fb331668d7a846b72b3b33eebc33c
Author: Eugene Burkov <E.Burkov@AdGuard.COM>
Date: Tue Jun 10 15:45:09 2025 +0300
filtering: upd blocked services
commit 6a1d473beb03a602cff4e38114a51e79a93708d5
Author: Eugene Burkov <E.Burkov@AdGuard.COM>
Date: Tue Jun 10 15:38:03 2025 +0300
all: upd go & tools
22 lines
820 B
Markdown
22 lines
820 B
Markdown
# AdGuard Home OpenAPI
|
||
|
||
We are using [OpenAPI specification](https://swagger.io/docs/specification/about/) to generate AdGuard Home API specification.
|
||
|
||
## How to edit the API spec
|
||
|
||
The easiest way would be to use [Swagger Editor](http://editor.swagger.io/) and just copy/paste the YAML file there.
|
||
|
||
## Changelog
|
||
|
||
See [`CHANGELOG.md`](CHANGELOG.md) where we keep track of all non-compatible changes that are being made.
|
||
|
||
## Authentication
|
||
|
||
If AdGuard Home’s web user is password-protected, a web client must use authentication mechanism when sending requests to server. Basic access authentication is the most simple method: a client must pass `Authorization` HTTP header along with all requests:
|
||
|
||
```http
|
||
Authorization: Basic BASE64_DATA
|
||
```
|
||
|
||
Where `BASE64_DATA` is base64-encoded data for `username:password` string.
|