c185f6826a
* openapi: get /profile * auth: store user names along with sessions |
||
---|---|---|
.. | ||
.gitignore | ||
CHANGELOG.md | ||
README.md | ||
index.html | ||
index.js | ||
openapi.yaml | ||
package.json | ||
yarn.lock |
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.
How to read the API doc
yarn install
yarn start
- Open
http://localhost:4000/
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.