Skip to content
NorthplaneNorthplane

Start a network discovery scan

POST
/api/v1/discovery/scans
curl --request POST \
  --url https://example.com/api/v1/discovery/scans \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "cidr": "example", "ports": [ 1 ] }'

Authorizations

Section titled “Authorizations”

Request Body

Section titled “Request Body”
Media typeapplication/json
object
cidr
required
string
ports
Array<integer>
Examplegenerated
{
  "cidr": "example",
  "ports": [
    1
  ]
}

Responses

Section titled “Responses”

202

Section titled “202”

Accepted

Media typeapplication/json
object
cidr
required
string
doneAt
string format: date-time
error
string
found
Array<object>
object
address
required
string
hostname
string
openPorts
required
Array<integer>
suggest
required
Array<string>
id
required
string
ports
required
Array<integer>
startedAt
required
string format: date-time
status
required
string
tenantId
required
string
Examplegenerated
{
  "cidr": "example",
  "doneAt": "2026-04-15T12:00:00Z",
  "error": "example",
  "found": [
    {
      "address": "example",
      "hostname": "example",
      "openPorts": [
        1
      ],
      "suggest": [
        "example"
      ]
    }
  ],
  "id": "example",
  "ports": [
    1
  ],
  "startedAt": "2026-04-15T12:00:00Z",
  "status": "example",
  "tenantId": "example"
}

default

Section titled “default”

Problem Details (RFC 9457)

Media typeapplication/problem+json
object
code
required
string
detail
string
instance
string
status
required
integer
title
required
string
type
required
string
Examplegenerated
{
  "code": "example",
  "detail": "example",
  "instance": "example",
  "status": 1,
  "title": "example",
  "type": "example"
}