mirrors/AdGuardHome
2
0
Fork 0
mirror of https://github.com/AdguardTeam/AdGuardHome.git synced 2025-10-26 11:27:18 +00:00
Code Issues Packages Projects Releases Wiki Activity
4a97445fef
AdGuardHome/openapi
History
Stanislav Chzhen 4ca8533efc Pull request 2438: AGDNS-3021-cache-enabled 
Merge in DNS/adguard-home from AGDNS-3021-cache-enabled to master

Squashed commit of the following:

commit b92dd03cd07e3fec55b70f29e3db57823c40c419
Author: Stanislav Chzhen <s.chzhen@adguard.com>
Date:   Tue Aug 5 19:18:59 2025 +0300

    all: imp chlog

commit 26338b6a484555b8a995fc523d861b496925c535
Author: Stanislav Chzhen <s.chzhen@adguard.com>
Date:   Tue Aug 5 18:20:06 2025 +0300

    all: fix chlog

commit 8b9a40080e335a715bbc6ff70984433d5349fb32
Merge: 9e915b0b2 86de4e75f
Author: Stanislav Chzhen <s.chzhen@adguard.com>
Date:   Tue Aug 5 18:17:20 2025 +0300

    Merge branch 'master' into AGDNS-3021-cache-enabled

commit 9e915b0b20
Author: Stanislav Chzhen <s.chzhen@adguard.com>
Date:   Mon Aug 4 17:45:47 2025 +0300

    client: imp docs

commit 8391be798a
Author: Ildar Kamalov <ik@adguard.com>
Date:   Mon Aug 4 16:26:32 2025 +0300

    ADG-10416 fix cache size error styles

commit 02c33fed2c
Author: Stanislav Chzhen <s.chzhen@adguard.com>
Date:   Thu Jul 24 17:59:00 2025 +0300

    bamboo-specs: fix ci

commit 7fbe7a5ec0
Author: Stanislav Chzhen <s.chzhen@adguard.com>
Date:   Wed Jul 23 20:32:25 2025 +0300

    all: imp docs

commit e681868d93
Author: Stanislav Chzhen <s.chzhen@adguard.com>
Date:   Tue Jul 22 14:36:32 2025 +0300

    all: imp docs

commit a5e7cc5223
Author: Stanislav Chzhen <s.chzhen@adguard.com>
Date:   Thu Jul 17 20:49:55 2025 +0300

    all: add tests

commit 1ec3ec24ae
Author: Stanislav Chzhen <s.chzhen@adguard.com>
Date:   Wed Jul 16 22:16:37 2025 +0300

    all: http api

commit fe49206905
Author: Stanislav Chzhen <s.chzhen@adguard.com>
Date:   Tue Jul 15 20:26:23 2025 +0300

    all: cache enabled
2025-08-05 19:39:49 +03:00
..
CHANGELOG.md Pull request 2438: AGDNS-3021-cache-enabled 2025-08-05 19:39:49 +03:00
index.html Pull request 1804: newline-lint 2023-04-06 14:21:46 +03:00
next.yaml Pull request 2431: next-fix-ups-logger 2025-06-27 18:27:54 +03:00
openapi.yaml Pull request 2438: AGDNS-3021-cache-enabled 2025-08-05 19:39:49 +03:00
README.md Pull request 2425: Update all 2025-06-10 16:58:45 +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.

Changelog

See CHANGELOG.md where 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.