mirrors/AdGuardHome
1
0
Fork 0
mirror of https://github.com/AdguardTeam/AdGuardHome.git synced 2025-03-14 06:28:31 +03:00
Code Issues Projects Releases Packages Wiki Activity
AdGuardHome/openapi
History
Exact
Stanislav Chzhen 2fe2d254b5 Pull request 2338: AGDNS-2665-upstream-timeout 
Merge in DNS/adguard-home from AGDNS-2665-upstream-timeout to master

Squashed commit of the following:

commit b4041c97f2
Merge: d939b3b3e b92a3cfb8
Author: Ainar Garipov <A.Garipov@AdGuard.COM>
Date:   Fri Feb 7 16:15:19 2025 +0300

    Merge branch 'master' into AGDNS-2665-upstream-timeout

commit d939b3b3ef
Author: Ainar Garipov <A.Garipov@AdGuard.COM>
Date:   Fri Feb 7 16:10:06 2025 +0300

    client: imp i18n

commit 52089adb6c
Author: Stanislav Chzhen <s.chzhen@adguard.com>
Date:   Thu Feb 6 18:39:53 2025 +0300

    all: fix typo

commit aca08b1873
Author: Ildar Kamalov <ik@adguard.com>
Date:   Thu Feb 6 15:19:30 2025 +0300

    client: rearrange upstream timeout settings

commit 48e75fabe2
Author: Stanislav Chzhen <s.chzhen@adguard.com>
Date:   Tue Feb 4 20:48:53 2025 +0300

    github: upd actions cache

commit 64bac193fc
Author: Stanislav Chzhen <s.chzhen@adguard.com>
Date:   Tue Feb 4 20:28:54 2025 +0300

    all: imp code

commit 95c7369898
Author: Stanislav Chzhen <s.chzhen@adguard.com>
Date:   Mon Feb 3 16:25:35 2025 +0300

    all: upstream timeout
2025-02-10 16:07:11 +03:00
..
CHANGELOG.md Pull request 2338: AGDNS-2665-upstream-timeout 2025-02-10 16:07:11 +03:00
index.html Pull request 1804: newline-lint 2023-04-06 14:21:46 +03:00
openapi.yaml Pull request 2338: AGDNS-2665-upstream-timeout 2025-02-10 16:07:11 +03:00
package.json *(documentation): removed unnecessary dependencies 2020-05-21 00:04:41 +03:00
README.md Pull request 2326: more-md-lint 2024-12-19 17:17:40 +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.