mirror of
https://github.com/AdguardTeam/AdGuardHome.git
synced 2024-11-15 18:08:30 -07:00
5292c7c387
Closes #3364. Squashed commit of the following: commit 840c20c87ccd64a83010718c68d65adcb390134d Author: Ainar Garipov <A.Garipov@AdGuard.COM> Date: Tue Jul 20 12:24:06 2021 +0300 openapi: upd version |
||
---|---|---|
.. | ||
.gitignore | ||
CHANGELOG.md | ||
index.html | ||
openapi.yaml | ||
package.json | ||
README.md | ||
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.