Skip to content
This repository has been archived by the owner on Aug 3, 2024. It is now read-only.

Commit

Permalink
docs: manual trigger (#78)
Browse files Browse the repository at this point in the history
  • Loading branch information
m-rots authored Dec 29, 2020
1 parent db7ee12 commit d3221a3
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -153,8 +153,22 @@ The following webhooks are currently provided by Autoscan:
- Radarr
- Lidarr

#### Manual Webhook

Autoscan also supports a `manual` webhook for custom scripts or for software which is not supported by Autoscan directly. The manual endpoint is available at `/triggers/manual`.

The manual endpoint accepts one or multiple directory paths as input and should be given one or multiple `dir` query parameters. Just like the other webhooks, the manual webhook is protected with basic authentication if the `auth` option is set in the config file of the user.

URL template: `POST /triggers/manual?dir=$path1&dir=$path2`

The following curl command sends a request to Autoscan to scan the directories `/test/one` and `/test/two`:

```bash
curl --request POST \
--url 'http://localhost:3030/triggers/manual?dir=%2Ftest%2Fone&dir=%2Ftest%2Ftwo' \
--header 'Authorization: Basic aGVsbG8gdGhlcmU6Z2VuZXJhbCBrZW5vYmk='
```

#### Configuration

A snippet of the `config.yml` file showcasing what is possible.
Expand Down

0 comments on commit d3221a3

Please sign in to comment.