API Reference

The NeuroStrike REST API lets you launch Strikes and pull results from your own tooling — CI pipelines, ticketing, or a SIEM. All endpoints live under https://neurostrike.com/api/v1 and return JSON.

AuthenticationCopy Anchor Link

Create an API key in the dashboard under Settings → API keys. The key is shown once — store it in a secrets manager. Each key belongs to one organization; every request made with it is scoped to that organization.

Send the key on every request, either as a bearer token or in the X-API-Key header:

curl -H "Authorization: Bearer $NEUROSTRIKE_API_KEY" \
  https://neurostrike.com/api/v1/target/list

PermissionsCopy Anchor Link

A key only grants the permissions you select when you create it. The defaults are scan:read, scan:write, and finding:read.

Keys can be given an expiry date and revoked at any time from the same settings page.

TargetsCopy Anchor Link

GET /api/v1/target/listCopy Anchor Link

List the organization's targets. Requires target:read.

GET /api/v1/target/getCopy Anchor Link

Get one target. Requires target:read.

StrikesCopy Anchor Link

POST /api/v1/scan/triggerCopy Anchor Link

Launch a Strike against a verified target. Requires scan:write.

curl -X POST https://neurostrike.com/api/v1/scan/trigger \
  -H "Authorization: Bearer $NEUROSTRIKE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "targetId": "tgt_123", "customInstructions": "Focus on the API; do not brute-force logins." }'

{ "scanId": "scn_456", "status": "QUEUED", "message": "Scan triggered successfully" }

The request is refused if the target is unverified or inactive, if it is marked as a production environment without production Strikes enabled, if its on-prem agent is offline, or if your plan's Strike quota is used up.

GET /api/v1/scan/listCopy Anchor Link

List Strikes, newest first. Requires scan:read.

GET /api/v1/scan/getCopy Anchor Link

Get one Strike with its findings. Requires scan:read.

Secrets found during a Strike are redacted from finding evidence before they are returned.

FindingsCopy Anchor Link

GET /api/v1/finding/listCopy Anchor Link

List findings across the organization. Requires finding:read.

PaginationCopy Anchor Link

List endpoints return a page of results and a cursor:

{ "items": [ ... ], "nextCursor": "clx..." }

Pass nextCursor as the cursor query parameter to get the next page. When nextCursor is absent, you have reached the end.

ErrorsCopy Anchor Link

Errors use standard HTTP status codes with a JSON body containing a message and a code:

Rate limitsCopy Anchor Link

Each API key may make 120 requests per minute. Requests over the limit receive 429; wait and retry with backoff.