rules
sifflet rules commands act on your monitors. The CLI and the API call monitors "rules", which is why the commands and options use that name.
sifflet rules has the following subcommands:
sifflet rules list: list all existing monitors and their IDssifflet rules run: trigger one or several monitorssifflet rules run-history: retrieve the run history of one monitor
sifflet rules list
Description
Display monitors created on Sifflet.
You can filter with --name to narrow your search.
sifflet rules list
sifflet rules list --name <search_criteria>Options
--name (string) (optional, default=None)
Filter monitors by monitor name.
--output (string) (optional, default=table)
Display the result either as a Table or raw JSON. Accepted values are
tableorjson.
--page-size (integer) (optional, default=15)
Page size of the server-side pagination, the default value is 15. Use this when you have many monitors and need to browse the pages.
--page-num (integer) (optional, default=0)
Page number of the server-side pagination, the default value is 0. Use this when you have many monitors and need to browse the pages.
sifflet rules run
Description
Run one or several monitors — requires monitor IDs.
Once the monitor is triggered, the shell waits for the run result. If a monitor fails, the program exits with exit 1. If the monitors succeed, the program exits with exit 0.
sifflet rules run --id <rule_id>
sifflet rules run --id <rule_id_1> --id <rule_id_2> --id <rule_id_3>Options
--id (string)
The monitor ID to trigger. You can specify multiple
--idparameters to run multiple monitors.
sifflet rules run-history
Description
Display all monitor runs for a given monitor ID.
sifflet rules run-history --id <rule_id>Options
--id (string) (required)
The ID of the monitor to fetch.
--output (string) (optional, default=table)
Display the result either as a Table or raw JSON. Accepted values are
tableorjson.
--page-size (integer) (optional, default=15)
Page size of the server-side pagination, the default value is 15. Use this when you have many monitors and need to browse the pages.
--page-num (integer) (optional, default=0)
Page number of the server-side pagination, the default value is 0. Use this when you have many monitors and need to browse the pages.
Updated 13 days ago