mirror of
https://github.com/AdguardTeam/AdGuardHome.git
synced 2025-02-20 11:44:09 +08:00
Some checks failed
build / test (macOS-latest) (push) Has been cancelled
build / test (ubuntu-latest) (push) Has been cancelled
build / test (windows-latest) (push) Has been cancelled
lint / go-lint (push) Has been cancelled
lint / eslint (push) Has been cancelled
build / build-release (push) Has been cancelled
build / notify (push) Has been cancelled
lint / notify (push) Has been cancelled
Merge in DNS/adguard-home from AGDNS-2665-upstream-timeout to master Squashed commit of the following: commit b4041c97f2ccd371a9cff8312bda72f4c18496b9 Merge: d939b3b3e b92a3cfb8 Author: Ainar Garipov <A.Garipov@AdGuard.COM> Date: Fri Feb 7 16:15:19 2025 +0300 Merge branch 'master' into AGDNS-2665-upstream-timeout commit d939b3b3ef2345d315c05a3730e81e1f1ea9f79f Author: Ainar Garipov <A.Garipov@AdGuard.COM> Date: Fri Feb 7 16:10:06 2025 +0300 client: imp i18n commit 52089adb6c28d8c47f5a916d9df941c5fddea1fc Author: Stanislav Chzhen <s.chzhen@adguard.com> Date: Thu Feb 6 18:39:53 2025 +0300 all: fix typo commit aca08b1873c9f39b8c1da0439a9057117e1dacce Author: Ildar Kamalov <ik@adguard.com> Date: Thu Feb 6 15:19:30 2025 +0300 client: rearrange upstream timeout settings commit 48e75fabe2f65aeac7156a020cce3d4c2412e5f9 Author: Stanislav Chzhen <s.chzhen@adguard.com> Date: Tue Feb 4 20:48:53 2025 +0300 github: upd actions cache commit 64bac193fc834a975e6913bb86a6bf27e54c382a Author: Stanislav Chzhen <s.chzhen@adguard.com> Date: Tue Feb 4 20:28:54 2025 +0300 all: imp code commit 95c73698985dc528a4af6ff0d3b8a301da1f0d4a Author: Stanislav Chzhen <s.chzhen@adguard.com> Date: Mon Feb 3 16:25:35 2025 +0300 all: upstream timeout
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.