mirror of
https://github.com/AdguardTeam/AdGuardHome.git
synced 2024-10-23 07:59:58 +08:00
b6ed769652
Squashed commit of the following:
commit 787b5d40394889510c24f4abc3a08410ecc96e5e
Author: Dimitry Kolyshev <dkolyshev@adguard.com>
Date: Wed Jul 31 15:09:18 2024 +0300
configmigrate: revert
commit a036638c05967298d13ef435dc5b377103cfe163
Author: Dimitry Kolyshev <dkolyshev@adguard.com>
Date: Wed Jul 31 09:37:25 2024 +0300
docs
commit a3b2e8de4bab7214dd6b260655bba9f45eee6bd2
Author: Dimitry Kolyshev <dkolyshev@adguard.com>
Date: Wed Jul 31 09:18:25 2024 +0300
locales
commit a01a22019ef02ae77e9006dd9444da462419908f
Author: Dimitry Kolyshev <dkolyshev@adguard.com>
Date: Wed Jul 31 09:02:14 2024 +0300
filtering: imp code
commit bc268cdd526c82cb605b1a474d51b79f593cd3da
Merge: 5ad88d914
|
||
---|---|---|
.. | ||
CHANGELOG.md | ||
index.html | ||
openapi.yaml | ||
package.json | ||
README.md | ||
v1.yaml | ||
yarn.lock |
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.
How To Read The API Doc
yarn install
yarn start
- Open
http://localhost:4000/
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.