Skip to main content

API Endpoints

Security Scanning​

Scan Codebase​

POST /scan

Scans a codebase for security vulnerabilities.

Request Body:

{
  "repository": "string",
  "branch": "string",
  "options": {
    "deep_scan": boolean,
    "include_dependencies": boolean
  }
}

Response:

{
  "success": true,
  "data": {
    "scan_id": "string",
    "vulnerabilities": [
      {
        "id": "string",
        "severity": "string",
        "description": "string",
        "location": "string"
      }
    ]
  }
}

Get Scan Results​

GET /scan/{scan_id}

Retrieves the results of a completed scan.

Monitoring​

Start Monitoring​

POST /monitor/start

Starts monitoring an infrastructure.

Request Body:

{
  "infrastructure_id": "string",
  "monitoring_options": {
    "alert_threshold": number,
    "scan_interval": number
  }
}

Get Monitoring Status​

GET /monitor/status/{infrastructure_id}

Retrieves the current monitoring status.

Compliance​

Check Compliance​

POST /compliance/check

Performs a compliance check against specified standards.

Request Body:

{
  "standards": ["string"],
  "scope": "string"
}

Generate Report​

POST /compliance/report

Generates a detailed compliance report.

Next Steps​