History

Dimitry Kolyshev 4a9dc1d6c1 docs: http client docs		2023-11-20 15:10:38 +02:00
..
CHANGELOG.md	docs: http client docs	2023-11-20 15:10:38 +02:00
README.md	Pull request: * home, openapi: improve docs and responses	2020-11-05 13:59:57 +03:00
index.html	Pull request 1804: newline-lint	2023-04-06 14:21:46 +03:00
openapi.yaml	docs: http client docs	2023-11-20 15:10:38 +02: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

Where BASE64_DATA is base64-encoded data for username:password string.