cotugno/AdGuardHome
2
Fork 0
mirror of https://github.com/AdguardTeam/AdGuardHome.git synced 2024-11-15 18:08:30 -07:00
Code Issues Packages Projects Releases Wiki Activity
d18219395a
AdGuardHome/openapi
History
Stanislav Chzhen 581891af22 Pull request 1992: 3701-fallback-dns-check 
Squashed commit of the following:

commit a5191def0b950cb7ab1ea737e9c8c6e8b65ec720
Merge: 7d127bfca 5bd452516
Author: Stanislav Chzhen <s.chzhen@adguard.com>
Date:   Wed Sep 6 12:21:08 2023 +0300

    Merge branch 'master' into 3701-fallback-dns-check

commit 7d127bfca54ac940c611681e6f48b89881491602
Author: Ildar Kamalov <ik@adguard.com>
Date:   Tue Sep 5 13:21:35 2023 +0300

    client: add fallback_dns to the upstream test

commit 970da7215503b5f05c53fcad47c715a96d9fc3c4
Author: Stanislav Chzhen <s.chzhen@adguard.com>
Date:   Mon Sep 4 19:23:35 2023 +0300

    all: add fallback dns check
2023-09-06 12:29:45 +03:00
..
CHANGELOG.md Pull request 1992: 3701-fallback-dns-check 2023-09-06 12:29:45 +03:00
index.html Pull request 1804: newline-lint 2023-04-06 14:21:46 +03:00
openapi.yaml Pull request 1992: 3701-fallback-dns-check 2023-09-06 12:29:45 +03:00
package.json *(documentation): removed unnecessary dependencies 2020-05-21 00:04:41 +03:00
README.md Pull request: * home, openapi: improve docs and responses 2020-11-05 13:59:57 +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

  1. yarn install
  2. yarn start
  3. 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.