History

Ainar Garipov 7aa08036b2 all: add more docs to lint		2024-12-19 16:08:13 +03:00
..
CHANGELOG.md	Pull request #2325 : 7510 Fix openapi spec	2024-12-19 15:38:18 +03:00
README.md	all: add more docs to lint	2024-12-19 16:08:13 +03:00
index.html	Pull request 1804: newline-lint	2023-04-06 14:21:46 +03:00
openapi.yaml	Pull request #2325 : 7510 Fix openapi spec	2024-12-19 15:38:18 +03:00
package.json	*(documentation): removed unnecessary dependencies	2020-05-21 00:04:41 +03:00
v1.yaml	Pull request: websvc-config-manager	2022-10-04 16:02:55 +03:00
yarn.lock	*(documentation): removed unnecessary dependencies	2020-05-21 00:04:41 +03:00

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 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