Quickstart - Strix

1. Create an API token

Go to Settings > API Access in the Strix dashboard. Create a new personal token with the scans:read scope.

2. List your recent pentests

curl -X GET "https://app.strix.ai/api/v1/scans?limit=5" \
  -H "Authorization: Bearer <YOUR_API_TOKEN>"

The response is a JSON document that contains your most recent pentests:

{
  "items": [
    {
      "id": "scan_abc123",
      "title": "Scan of example.com",
      "status": "completed",
      "scan_type": "blackbox",
      "findings": { "total": 7, "critical": 1, "high": 2, "medium": 3, "low": 1 },
      "created_at": "2026-04-07T10:00:00Z"
    }
  ],
  "meta": {
    "page": 1,
    "limit": 5,
    "total_items": 42,
    "total_pages": 9,
    "has_next": true,
    "has_prev": false
  }
}

3. Update a vulnerability status

Create a token with the vulnerabilities:write scope. Then set the status of a finding to in-progress:

curl -X PATCH "https://app.strix.ai/api/v1/vulnerabilities/<VULNERABILITY_ID>" \
  -H "Authorization: Bearer <YOUR_API_TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{"status":"in_progress","note":"Linked to remediation ticket"}'

4. Trigger a schedule

If you have pentest schedules, you can trigger one immediately:

curl -X POST "https://app.strix.ai/api/v1/schedules/<SCHEDULE_ID>/trigger" \
  -H "Authorization: Bearer <YOUR_API_TOKEN>"

Next steps

Authentication

Learn about the token types and scopes

Webhooks

Subscribe to pentest and vulnerability events