Create an API key and take your first action

Let a script, CI job or SOAR playbook read data and respond to threats, under the same rules as your team.

Create a key with the scopes it needs

Only an organization owner can create keys. In Settings → API keys, name the key after what will use it, pick a preset (Respond to threats can read servers and alerts and take response actions), and give it an expiry. The key is shown once: copy it into your secret store.

Take an action

curl -X POST \
     -H "Authorization: Bearer $VIGILHOLD_API_KEY" \
     -H "Content-Type: application/json" \
     -d '{ "serverId": "4f2a9c1e8b7d6a50", "ip": "185.220.101.45", "reason": "Flagged by our threat feed" }' \
     https://vigilhold.com/api/automation/ban-ip

The same works for stopping a process (/api/automation/kill), quarantining a file (/api/automation/quarantine) and lockdown.

Know what happens next

A key follows your approval policies like a person does. If an action needs approval the call answers 202 with an approval_id, and it runs once someone approves it. A 202 alone does not mean approval is needed: check for pending_approval / approval_id in the response. Each server's own limits still apply; simulation mode covers stopping processes and quarantining files. The audit log records the action under api-key:nightly-drill.

API: Automation Actions · OpenAPI spec

All Vigilhold docs · Start a 14-day free trial