Back to Home

Documentation

Everything you need to integrate, configure, and get the most out of NetSpectraAI's network configuration intelligence platform.

API Quick Reference

Authentication

All API requests require an API key passed in the Authorization header:

Authorization: Bearer YOUR_API_KEY
POST/api/v1/analyze

Submit a configuration for analysis

{
  "config": "! Cisco IOS configuration...",
  "device_type": "cisco_ios",
  "analysis_type": "full"
}
GET/api/v1/reports/{report_id}

Retrieve analysis report by ID

GET/api/v1/reports

List all reports for your organization

POST/api/v1/export

Export report in PDF, HTML, or Excel format

Quick Start Examples

Python
import requests

API_KEY = "your_api_key"
BASE_URL = "https://api.netspectra.ai/v1"

# Analyze a configuration
response = requests.post(
    f"{BASE_URL}/analyze",
    headers={"Authorization": f"Bearer {API_KEY}"},
    json={
        "config": open("router.cfg").read(),
        "device_type": "cisco_ios"
    }
)

report = response.json()
print(f"Found {len(report['findings'])} issues")
cURL
# Analyze a configuration file
curl -X POST https://api.netspectra.ai/v1/analyze \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "config": "hostname router1\n...",
    "device_type": "cisco_ios",
    "analysis_type": "full"
  }'

# Get report
curl https://api.netspectra.ai/v1/reports/abc123 \
  -H "Authorization: Bearer YOUR_API_KEY"

Supported Devices

Fully Supported

  • Cisco IOS / IOS-XE
  • Cisco IOS-XR
  • Cisco NX-OS
  • Juniper JunOS
  • Arista EOS

Beta Support

  • Palo Alto PAN-OS
  • Fortinet FortiOS
  • HP/Aruba

Coming Soon

  • F5 BIG-IP
  • Check Point
  • Ubiquiti
  • MikroTik

Need Help Getting Started?

Our team is here to help you integrate NetSpectraAI into your workflow. Schedule a demo or reach out for technical support.