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
cefb3fba50
AdGuardHome/openapi
History
Fedor Setrakov d0b89e4d36 Pull request 2483: AGDNS-3175-sup-service-groups 
Updates \#6336.
Updates \#7984.

Squashed commit of the following:

commit 58d6608217caf3d0bc695e7411d139300de03853
Merge: 7a8c0715d cee947f58
Author: f.setrakov <f.setrakov@adguard.com>
Date:   Fri Sep 26 14:36:58 2025 +0300

    Merge branch 'master' into AGDNS-3175-sup-service-groups

commit 7a8c0715d74554bc2e9ac1e66292ef8f88be6f16
Merge: 29607d440 394b8c529
Author: f.setrakov <f.setrakov@adguard.com>
Date:   Fri Sep 26 14:19:49 2025 +0300

    Merge branch 'master' into AGDNS-3175-sup-service-groups

commit 29607d4404
Author: f.setrakov <f.setrakov@adguard.com>
Date:   Tue Sep 23 20:17:00 2025 +0300

    all: imp changelog, openapi

commit a11fefe34c
Author: f.setrakov <f.setrakov@adguard.com>
Date:   Tue Sep 23 17:11:26 2025 +0300

    all: imp docs and changelog, codegen, added group field

commit f97a04da25
Author: f.setrakov <f.setrakov@adguard.com>
Date:   Mon Sep 22 15:54:40 2025 +0300

    openapi: imp new field description

commit 7f13e2a098
Author: f.setrakov <f.setrakov@adguard.com>
Date:   Fri Sep 19 18:49:03 2025 +0300

    openapi: changed versions

commit 094822ae68
Author: f.setrakov <f.setrakov@adguard.com>
Date:   Fri Sep 19 17:43:04 2025 +0300

    openapi: fix typo in docs

commit c1f1a67c8a
Author: f.setrakov <f.setrakov@adguard.com>
Date:   Fri Sep 19 17:36:53 2025 +0300

    all: sup blocked service groups, upd docs
2025-09-26 14:56:12 +03:00
..
CHANGELOG.md
index.html
next.yaml
openapi.yaml
README.md

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.