Murzaby/Adguardhome
1
0
Fork 0
mirror of https://github.com/AdguardTeam/AdGuardHome.git synced 2026-08-04 15:28:58 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 12
Adguardhome/openapi
History
Exact
Eugene Burkov f115af2f65 Pull request 2737: upd-chlog 
Squashed commit of the following:

commit fb0e9ef65c1f3b3d9c9b6e23bbf140c1bee565c0
Author: Eugene Burkov <e.burkov@adguard.com>
Date:   Thu Jul 30 14:29:39 2026 +0300

    all: fix chlog
2026-07-30 12:09:13 +00:00
..
CHANGELOG.md Pull request 2737: upd-chlog 2026-07-30 12:09:13 +00:00
index.html Pull request 1804: newline-lint 2023-04-06 14:21:46 +03:00
next.yaml Pull request 2608: imp-doc 2026-03-17 11:46:28 +00:00
openapi.yaml Pull request 2723: AGDNS-4277 generate client api using openapi specs 2026-07-27 11:17:46 +00: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.