Write a rule

When something happens on the servers you choose, notify, open a ticket or respond, within the limits each server is set to.

Start from the library, or press New rule

Open Rules. The Library tab has rules to start from; Add as a draft puts one in your organization without running it. New rule starts an empty one.

Say when, where, if and then

When is one trigger: a Vigilhold alert, something Vigilhold notices (a server goes offline, new vulnerabilities), an event from another tool, or a schedule in your business time zone. Where is any server, a watch group, a tag, a role or named servers. If adds conditions that must all hold, such as *severity is at least warning* or *source ip is not trusted*. Then is up to five actions in order.

Under the form, the rule reads back as a sentence, and Last 7 days shows what it would have done over the past week.

Let a rule that acts prove itself first

A rule that only notifies, emails, tags or acknowledges works as soon as you save it. A rule that bans, stops a process, quarantines a file or locks a server down runs as a dry run for 7 days: it records what it would have done and changes nothing. Open it on the Rules page to read that record, then press Go live.

Once live, each response runs on its own only where the server allows it: a ban unless the server is set to Observe only, stopping a process or quarantining a file only where it acts within limits, and lockdown never. Anywhere else a person is asked, in the dashboard and in Slack if it is connected, and the rest of the rule waits for the answer.

Know the limits that always apply

A rule that responds acts on a limited number of servers in a short time (you can raise the limit), then pauses itself and emails its owner what it was about to do. It does not act on the same server or address over and over. Bans from rules lift on their own; In force lists them with Lift now. Your trusted addresses, your team's sign-in addresses and Vigilhold itself are never banned. A rule that keeps failing turns itself off and says why. Pause all rules stops every rule at once.

Let other tools start rules

On the Incoming tab, add Grafana, GitHub or your own tool. Each source gets its own address and signing secret, shown once. Grafana: add a webhook contact point, turn on HMAC signature, and set the Timestamp Header to X-Grafana-Alerting-Timestamp. GitHub: add a webhook with the secret. Then make a rule whose trigger is An event from another tool.

Deliveries with a bad signature, an old timestamp, a repeat, or a server outside your organization are refused and counted on the source.

Keep rules in Git

Export YAML downloads every rule; Import YAML applies a file, updating rules with the same name. With an API key that has rules:read and rules:write:

curl -H "Authorization: Bearer $VIGILHOLD_API_KEY" https://vigilhold.com/api/rules/export > rules.yaml

Imported rules that act still run their dry run.

OpenAPI spec (Rules, Incoming)

All Vigilhold docs · Start a 14-day free trial