AEGIS API Sentinel

Black-box API security assessment directly from VS Code.

AEGIS API Sentinel helps developers assess the security of an API endpoint and review the results in a visual dashboard.

Features

• Security assessment score out of 100
• Passed, failed, and warning check summaries
• Security check distribution chart
• Detailed findings with severity and status
• Evidence and remediation details when available
• Live scan status updates
• Clean, dark-themed dashboard

Requirements

• Visual Studio Code
• Node.js and npm for development
• The AEGIS Python backend running locally
• Python dependencies installed for the backend

Setup

1. Start the AEGIS backend

Open a terminal in your backend directory and run:

uvicorn app.main:app --reload --host 127.0.0.1 --port 8000

Confirm the API is available at:

http://127.0.0.1:8000/docs

2. Install the extension

Install AEGIS API Sentinel from the Visual Studio Code Marketplace once it is published.

3. Run a scan

1. Open the Command Palette in VS Code.
2. Search for AEGIS: Scan API.
3. Enter the URL of an API you own or are authorized to assess.
4. Click Scan API.
5. Review the security score, check distribution, and findings.

Backend connection

The extension connects to the local backend at:

http://127.0.0.1:8000/api

The backend must be running for scans to work. The extension does not currently bundle or automatically install the Python backend.

Security and limitations

• Only scan APIs you own or have explicit permission to test.
• Results depend on the checks and information provided by the AEGIS backend.
• A scan score is an assessment indicator, not a guarantee that an API is secure.
• This extension performs black-box assessment; it does not replace a complete security audit.

License

See the repository's LICENSE file for licensing terms.