54a141abde
Merge in DNS/adguard-home from remove-client2 to master
Squashed commit of the following:
commit 0a0923494b0d1003e4f02f3a5f93d5248f0f2ded
Author: Ainar Garipov <A.Garipov@AdGuard.COM>
Date: Fri Jan 20 17:14:29 2023 +0300
all: rm old experimental beta (dir client2/)
This project was unfortunately abandoned. v0.108.0 will have a
different front-end and new APIs.
|
||
|---|---|---|
| .. | ||
| .gitignore | ||
| CHANGELOG.md | ||
| README.md | ||
| index.html | ||
| openapi.yaml | ||
| package.json | ||
| v1.yaml | ||
| yarn.lock | ||
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.
How To Read The API Doc
yarn installyarn 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.