API - Developer Portal | Panoptic Scans

Interactive Documentation

Explore every endpoint with live examples you can try directly in your browser.

Download YAML

Get the full OpenAPI specification in YAML format for use with your tools.

Download JSON

Get the full OpenAPI specification in JSON format for code generation and imports.

Quick Start

bash

# 1. Get an API token
curl -X POST "https://panopticscans.com/api/token?key=YOUR_API_KEY"

# 2. List all scans
curl -X GET "https://panopticscans.com/api/scans" \
  -H "Authorization: Bearer YOUR_TOKEN"

# 3. Create a new scan
curl -X POST "https://panopticscans.com/api/new-scan" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "scan_name": "Production Scan",
    "scan_type": "Nmap",
    "scan_frequency": "Weekly",
    "scan_target": "192.168.1.0/24"
  }'

Authentication

The API uses JWT bearer-token authentication. Create an API key from your account settings, exchange it for a token via the /api/token endpoint, and include Authorization: Bearer <token> on every subsequent request.

Capabilities

Scans — Create, list, update, delete, and rerun scans

Vulnerabilities — Browse and filter discovered findings

Targets — Manage hosts, IPs, and URLs

Webhooks — Receive real-time scan event notifications

Reports — Download PDF and CSV scan reports

Tokens — Issue, refresh, and revoke API tokens

Need more detail? Explore our fully interactive API reference.

Developer API