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
1ec3ec24ae
AdGuardHome/openapi
History
Stanislav Chzhen 1ec3ec24ae all: http api
2025-07-16 22:16:37 +03:00
..
CHANGELOG.md all: http api 2025-07-16 22:16:37 +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 all: http api 2025-07-16 22:16:37 +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.