Module autopulse::routes::triggers

GET/POST /trigger/{name}

Triggers a new scan event. Where name is as defined in the settings file.

GET is used for manual triggers, while POST is used for automated triggers.

See the Triggers module for more information.

Responses

• 200 OK: Returns a ScanEvent object containing the scan event.
• 401 Unauthorized: Returned if the request is not authenticated.
• 404 Not Found: Returned if the trigger does not exist.
• 400 Bad Request: Returned if the request is invalid.

Example:

triggers:
 my_sonarr:
  type: sonarr

 my_manual:
  type: manual

$ curl -u 'admin:password' 'http://localhost:8080/trigger/my_manual?path=/path/to/file'
{
    ...
}

Structs

• trigger_get
• trigger_post