mirror of
https://github.com/AdguardTeam/AdGuardHome.git
synced 2025-10-26 11:27:18 +00:00
Merge in DNS/adguard-home from AGDNS-2750-find-client to master Squashed commit of the following: commit 98f1a8ca4622b6f502a5092273b9724203fe0bd8 Merge: |
||
|---|---|---|
| .. | ||
| CHANGELOG.md | ||
| index.html | ||
| next.yaml | ||
| openapi.yaml | ||
| README.md | ||
AdGuard Home OpenAPI
We are using OpenAPI specification to generate AdGuard Home API specification.
How to edit the API spec
The easiest way would be to use Swagger Editor and just copy/paste the YAML file there.
Changelog
Here 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:
Authorization: Basic BASE64_DATA
Where BASE64_DATA is base64-encoded data for username:password string.