2020-11-05 10:59:57 +00:00
|
|
|
# AdGuard Home OpenAPI
|
2018-11-25 17:09:52 +00:00
|
|
|
|
2020-11-05 10:59:57 +00:00
|
|
|
We are using
|
|
|
|
|
[OpenAPI specification](https://swagger.io/docs/specification/about/)
|
|
|
|
|
to generate AdGuard Home API specification.
|
2018-11-25 17:09:52 +00:00
|
|
|
|
2020-11-05 10:59:57 +00:00
|
|
|
## How To Edit The API Spec
|
2018-11-25 17:09:52 +00:00
|
|
|
|
2020-11-05 10:59:57 +00:00
|
|
|
The easiest way would be to use
|
|
|
|
|
[Swagger Editor](http://editor.swagger.io/)
|
|
|
|
|
and just copy/paste the YAML file there.
|
2018-11-25 17:09:52 +00:00
|
|
|
|
2020-11-05 10:59:57 +00:00
|
|
|
## How To Read The API Doc
|
2018-11-25 17:09:52 +00:00
|
|
|
|
|
|
|
|
1. `yarn install`
|
|
|
|
|
2. `yarn start`
|
2018-12-12 14:25:42 +00:00
|
|
|
3. Open `http://localhost:4000/`
|
2019-08-29 10:34:07 +01:00
|
|
|
|
2020-11-05 10:59:57 +00:00
|
|
|
## Changelog
|
2020-05-20 22:04:41 +01:00
|
|
|
|
2020-11-05 10:59:57 +00:00
|
|
|
[Here](CHANGELOG.md) we keep track of all non-compatible changes that are being
|
|
|
|
|
made.
|
2019-08-29 10:34:07 +01:00
|
|
|
|
2020-11-05 10:59:57 +00:00
|
|
|
## Authentication
|
2019-08-29 10:34:07 +01:00
|
|
|
|
2020-11-05 10:59:57 +00:00
|
|
|
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:
|
2019-08-29 10:34:07 +01:00
|
|
|
|
2020-11-05 10:59:57 +00:00
|
|
|
```http
|
|
|
|
|
Authorization: Basic BASE64_DATA
|
|
|
|
|
```
|
2019-08-29 10:34:07 +01:00
|
|
|
|
2020-11-05 10:59:57 +00:00
|
|
|
Where BASE64_DATA is base64-encoded data for `username:password` string.
|
