Murzaby/Adguardhome
1
0
Fork 0
mirror of https://github.com/AdguardTeam/AdGuardHome.git synced 2026-06-27 19:31:26 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
Adguardhome/openapi
History
Exact
Ainar Garipov 54e6e30022
Some checks failed
build / test (macOS-latest) (push) Has been cancelled
Details
build / test (ubuntu-latest) (push) Has been cancelled
Details
build / test (windows-latest) (push) Has been cancelled
Details
lint / go-lint (push) Has been cancelled
Details
lint / eslint (push) Has been cancelled
Details
build / build-release (push) Has been cancelled
Details
build / notify (push) Has been cancelled
Details
lint / notify (push) Has been cancelled
Details
Pull request 2674: custom-flt-upd-ivl 
Squashed commit of the following:

commit 37db2dd9d3
Author: Ainar Garipov <a.garipov@adguard.com>
Date:   Tue Jun 9 20:37:36 2026 +0300

    filtering: imp docs

commit 1ebd8f30c6
Author: Ainar Garipov <a.garipov@adguard.com>
Date:   Tue Jun 9 17:55:40 2026 +0300

    all: allow custom filter update intervals
2026-06-10 10:32:48 +00:00
..
CHANGELOG.md Pull request 2674: custom-flt-upd-ivl 2026-06-10 10:32:48 +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 2658: AGDNS-3951-imp-querylog-docs 2026-05-20 12:15:51 +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.