Skip to main content
POST
Start network scan (async)

Authorizations

Authorization
string
header
required

OIDC/JWKS bearer token. Self-hosted defaults to Pocket ID; SaaS uses Auth0 through the edge. PocketBase JWT is legacy migration compatibility only.

Body

application/json
subnet
string
Example:

"192.168.1.0/24"

target_ips
string[]
exclude_ips
string[]
timeout_seconds
integer
default:30
max_concurrent
integer
default:50
profile
enum<string>
default:passive
Available options:
passive,
active

Response

200 - application/json

Scan started

scan_id
string
status
enum<string>
Available options:
running,
completed,
cancelled,
failed
profile
string
subnet
string
target_ips
string[]
exclude_ips
string[]
devices
object[]
started_at
string<date-time>
progress
object