netalertx/api-development
.github/skills/api-development/SKILL.md
Develop and extend NetAlertX REST API endpoints. Use this when asked to create endpoint, add API route, implement API, or modify API responses.
$ install --global
skillsauthnpx skillsauth add netalertx/netalertx api-developmentInstall this skill globally with one command. Works with Claude Code, Cursor, and Windsurf.
Security Scan Results
3 of 9 scanners reported clean
Some scanners were skipped, did not run, or reported a non-clean status. Review each row below.
3
Scanners Passed
9
Scanners in report
Clean
TrivyContainer and dependency vulnerability scanner
95%
Clean
SemgrepStatic code analysis for vulnerabilities
95%
Clean
mcp-scan (Snyk)Model Context Protocol security validation
95%
Skipped
Snyk (dep)Open source security scanning
50%
Skipped
Socket.devSupply chain security analysis
50%
Skipped
VirusTotalMulti-engine malware detection
50%
Skipped
CrowdStrikeAdvanced threat intelligence
50%
Skipped
OSV-ScannerOpen Source Vulnerability database check
50%
Skipped
OWASP Dep-Check
50%
Last scanned: Apr 9, 2026, 2:41 AM7.3s1 file scanned
SKILL.md
- name:
- api-development
- description:
- Develop and extend NetAlertX REST API endpoints. Use this when asked to create endpoint, add API route, implement API, or modify API responses.
API Development
Entry Point
Flask app: server/api_server/api_server_start.py
Existing Routes
/device/<mac>- Single device operations/devices- Device list/devices/export/{csv,json}- Export devices/devices/import- Import devices/devices/totals- Device counts/devices/by-status- Devices grouped by status/nettools- Network utilities/events- Event log/sessions- Session management/dbquery- Database queries/metrics- Prometheus metrics/sync- Synchronization
Authorization
All routes require header:
Authorization: Bearer <API_TOKEN>
Retrieve token via get_setting_value('API_TOKEN').
Response Contract
MANDATORY: All responses must include "success": true|false
return {"success": False, "error": "Description of what went wrong"}
On success:
return {"success": True, "data": result}
return {"success": False, "error": "Description of what went wrong"}
On success:
return {"success": True, "data": result}
Exception: The legacy /device/<mac> GET endpoint does not follow this contract to maintain backward compatibility with the UI.
Adding New Endpoints
- Add route in
server/api_server/directory - Follow authorization pattern
- Return proper response contract
- Update UI to read/write JSON cache (don't bypass pipeline)
Related Skills
netalertx/netalertx-settings-management
tools
VerifiedTrustedCommunity
Manage NetAlertX configuration settings. Use this when asked to add setting, read config, get_setting_value, ccd, or configure options.
5,989SKILL.mdUpdated Apr 9, 2026
netalertx/netalertx-sample-data
development
VerifiedTrustedCommunity
Load synthetic device data into the devcontainer. Use this when asked to load sample devices, seed data, import test devices, populate database, or generate test data.
5,989SKILL.mdUpdated Apr 9, 2026
netalertx/netalertx-plugin-run-development
tools
VerifiedTrustedCommunity
Create and run NetAlertX plugins. Use this when asked to create plugin, run plugin, test plugin, plugin development, or execute plugin script.
5,989SKILL.mdUpdated Apr 9, 2026
netalertx/netalertx-docker-prune
devops
VerifiedTrustedCommunity
Clean up unused Docker resources. Use this when asked to prune docker, clean docker, remove unused images, free disk space, or docker cleanup. DANGEROUS operation. Requires human confirmation.
5,989SKILL.mdUpdated Apr 9, 2026