انتقل إلى المحتوى الرئيسي

cURL API Examples

All examples assume you have set your API key or token:

# Option A: API Key
export NR_KEY="nr_live_xxxxxxxxxxxx"
export NR_AUTH="-H 'X-API-Key: $NR_KEY'"

# Option B: JWT Token
export NR_TOKEN="eyJhbGciOi..."
export NR_AUTH="-H 'Authorization: Bearer $NR_TOKEN'"

export NR_BASE="https://api.netreconapp.com/api/v1"

Authentication​

Login​

curl -X POST "$NR_BASE/auth/login" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "user@company.com",
    "password": "your-password"
  }'

Login with 2FA​

curl -X POST "$NR_BASE/auth/login" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "user@company.com",
    "password": "your-password",
    "totp_code": "123456"
  }'

Scanning​

Start a Scan​

curl -X POST "$NR_BASE/scans/start" \
  -H "X-API-Key: $NR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "target": "192.168.1.0/24",
    "profile": "normal"
  }'

Check Scan Status​

curl "$NR_BASE/scans/SCAN_ID" \
  -H "X-API-Key: $NR_KEY"

Get Scan Results​

curl "$NR_BASE/scans/SCAN_ID/result" \
  -H "X-API-Key: $NR_KEY"

Stop a Scan​

curl -X POST "$NR_BASE/scans/SCAN_ID/stop" \
  -H "X-API-Key: $NR_KEY"

Devices​

List All Devices​

curl "$NR_BASE/devices" \
  -H "X-API-Key: $NR_KEY"

Filter by Site​

curl "$NR_BASE/devices?site_id=SITE_UUID&is_online=true" \
  -H "X-API-Key: $NR_KEY"

Get Device Details​

curl "$NR_BASE/devices/DEVICE_ID" \
  -H "X-API-Key: $NR_KEY"

Get Device Ports​

curl "$NR_BASE/devices/DEVICE_ID/ports" \
  -H "X-API-Key: $NR_KEY"

Alerts​

List Open Alerts​

curl "$NR_BASE/alerts?status=open&severity=high" \
  -H "X-API-Key: $NR_KEY"

Acknowledge an Alert​

curl -X POST "$NR_BASE/alerts/ALERT_ID/acknowledge" \
  -H "X-API-Key: $NR_KEY"

Resolve an Alert​

curl -X POST "$NR_BASE/alerts/ALERT_ID/resolve" \
  -H "X-API-Key: $NR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"resolution_note": "Firewall rule updated"}'

CVE Intelligence​

Get Affected Devices​

curl "$NR_BASE/cve/affected?cvss_min=7.0" \
  -H "X-API-Key: $NR_KEY"

Search CVEs​

curl "$NR_BASE/cve/search?q=apache+log4j" \
  -H "X-API-Key: $NR_KEY"

API Key Management​

Create an API Key​

curl -X POST "$NR_BASE/api-keys" \
  -H "X-API-Key: $NR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Monitoring Script",
    "permissions": ["scans_read", "devices_read", "alerts_read"],
    "expires_in_days": 90
  }'

List API Keys​

curl "$NR_BASE/api-keys" \
  -H "X-API-Key: $NR_KEY"

Revoke an API Key​

curl -X DELETE "$NR_BASE/api-keys/KEY_UUID" \
  -H "X-API-Key: $NR_KEY"

IDS​

Get IDS Alerts​

curl "$NR_BASE/ids/alerts" \
  -H "X-API-Key: $NR_KEY"

Start IDS​

curl -X POST "$NR_BASE/ids/start" \
  -H "X-API-Key: $NR_KEY"

Backup​

List Backups​

curl "$NR_BASE/backup/list" \
  -H "X-API-Key: $NR_KEY"

Run a Backup​

curl -X POST "$NR_BASE/backup/run" \
  -H "X-API-Key: $NR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"type": "full"}'

Pagination​

Page Through Results​

# Page 1
curl "$NR_BASE/devices?page=1&per_page=50" \
  -H "X-API-Key: $NR_KEY"

# Page 2
curl "$NR_BASE/devices?page=2&per_page=50" \
  -H "X-API-Key: $NR_KEY"

Useful Recipes​

Export All Devices as JSON​

curl -s "$NR_BASE/devices?per_page=1000" \
  -H "X-API-Key: $NR_KEY" | jq '.data' > devices.json

Count Open Alerts by Severity​

curl -s "$NR_BASE/alerts?status=open&per_page=1" \
  -H "X-API-Key: $NR_KEY" | jq '.meta.total'

Watch for New Alerts (polling)​

while true; do
  curl -s "$NR_BASE/alerts?status=open&since=$(date -u -d '5 minutes ago' +%Y-%m-%dT%H:%M:%SZ)" \
    -H "X-API-Key: $NR_KEY" | jq '.data[] | "\(.severity): \(.title)"'
  sleep 300
done