Files
AdGuardHome/openapi
Dimitry Kolyshev e1995408e4 Pull request: 6263 custom ups cache
Updates #6263.

Squashed commit of the following:

commit f6b704fb58bb341b7fe9432fce823d7b3bf3ec9e
Merge: 780d001ce 5dd10d9fc
Author: Dimitry Kolyshev <dkolyshev@adguard.com>
Date:   Fri Nov 24 09:55:04 2023 +0200

    Merge remote-tracking branch 'origin/master' into 6263-custom-ups-cache

commit 780d001cef93ee5c4e45b55f5ae17f8ba1e01a50
Author: Dimitry Kolyshev <dkolyshev@adguard.com>
Date:   Fri Nov 24 09:53:46 2023 +0200

    all: imp locales

commit 820bcf0e2332408a218fb12bec4e299871608756
Merge: e7ca51563 1320043e9
Author: Dimitry Kolyshev <dkolyshev@adguard.com>
Date:   Thu Nov 23 11:16:54 2023 +0200

    Merge remote-tracking branch 'origin/master' into 6263-custom-ups-cache

    # Conflicts:
    #	CHANGELOG.md

commit e7ca515630bb7a543cd94460c5b063e5e4ab7aff
Merge: 23392d08b 0f5e8ca56
Author: Dimitry Kolyshev <dkolyshev@adguard.com>
Date:   Wed Nov 22 09:49:32 2023 +0200

    Merge remote-tracking branch 'origin/master' into 6263-custom-ups-cache

commit 23392d08b13a5c339a8f1e2be266a7a35dd093d4
Merge: a09cd190c feb15745d
Author: Dimitry Kolyshev <dkolyshev@adguard.com>
Date:   Wed Nov 22 09:49:10 2023 +0200

    Merge remote-tracking branch 'origin/6263-custom-ups-cache' into 6263-custom-ups-cache

commit a09cd190c03cb65ce6eece7582d72ad73920415e
Author: Dimitry Kolyshev <dkolyshev@adguard.com>
Date:   Wed Nov 22 09:48:43 2023 +0200

    home: imp code

commit feb15745d2e867e360cd97de6763a668d6921158
Author: Ildar Kamalov <ik@adguard.com>
Date:   Tue Nov 21 17:27:38 2023 +0300

    client: move cache fields to the upstream tab

commit 789060e4d439a7d32b606625353c826c61a1db85
Author: Ildar Kamalov <ik@adguard.com>
Date:   Tue Nov 21 16:28:03 2023 +0300

    client: add form fields

commit a700bfb42e94a03ecc8abefb12e77548a201cb28
Merge: 7669419b5 db42254d7
Author: Dimitry Kolyshev <dkolyshev@adguard.com>
Date:   Tue Nov 21 11:44:14 2023 +0200

    Merge remote-tracking branch 'origin/master' into 6263-custom-ups-cache

commit 7669419b5981bf456af13b9374474c4a932d7c00
Author: Dimitry Kolyshev <dkolyshev@adguard.com>
Date:   Tue Nov 21 11:34:17 2023 +0200

    home: imp code

commit 4a9dc1d6c1f3dfe56737f482becdfe465189d444
Author: Dimitry Kolyshev <dkolyshev@adguard.com>
Date:   Mon Nov 20 15:08:44 2023 +0200

    docs: http client docs

commit 944e0d7a4be3313f360ddace8bd7e0080512ddf8
Author: Dimitry Kolyshev <dkolyshev@adguard.com>
Date:   Mon Nov 20 13:51:00 2023 +0200

    home: http client dns cache
2023-11-24 15:20:32 +03:00
..
2023-04-06 14:21:46 +03:00
2022-10-04 16:02:55 +03:00

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.

How To Read The API Doc

  1. yarn install
  2. yarn start
  3. Open http://localhost:4000/

Changelog

Here 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.