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

Commit d3221a3

Browse files
authored
docs: manual trigger (#78)
1 parent db7ee12 commit d3221a3

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -153,8 +153,22 @@ The following webhooks are currently provided by Autoscan:
153153
- Radarr
154154
- Lidarr
155155

156+
#### Manual Webhook
157+
156158
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`.
157159

160+
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.
161+
162+
URL template: `POST /triggers/manual?dir=$path1&dir=$path2`
163+
164+
The following curl command sends a request to Autoscan to scan the directories `/test/one` and `/test/two`:
165+
166+
```bash
167+
curl --request POST \
168+
--url 'http://localhost:3030/triggers/manual?dir=%2Ftest%2Fone&dir=%2Ftest%2Ftwo' \
169+
--header 'Authorization: Basic aGVsbG8gdGhlcmU6Z2VuZXJhbCBrZW5vYmk='
170+
```
171+
158172
#### Configuration
159173

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

0 commit comments

Comments
 (0)