Explorer Scan

Queues a discovery operation on an edge node. Scans run asynchronously - this endpoint returns an op_id once the operation is queued, and the results are read from Explorer Sources after it completes. See Explorer for the full sequence.

POST /v1/explorer/scan

curl https://api.novant.io/v1/explorer/scan \
  -X POST \
  -u ak_sample_123: \
  -d op=bacnet-scan \
  --compressed

Parameters

op Required: The discovery operation to run. See Operations below for the parameters each one accepts.
node_id: Serial number of the edge node to run this operation on. If not specified, the first node in the project is used.

Operations

Each op accepts its own parameters. Any parameter not specified falls back to the default shown, and the operation is queued fully specified.

Credentials are referenced by name, not id - the same name shown in Project Settings. The credential must match the type the operation requires, and its secrets are never returned by the API. Comma separated lists must not contain newlines.

`bacnet-scan`

Broadcasts across a range of device instance ids.

Parameter	Default	Description
`port`	`47808`	UDP port to scan.
`range_low`	`0`	Lowest device instance id to scan (`0`-`4194303`).
`range_high`	`4194303`	Highest device instance id to scan (`0`-`4194303`).

`bacnet-find`

Probes an explicit list of addresses. Use this when broadcast traffic does not reach the devices - across subnets, for example.

Parameter	Required	Default	Description
`ip_addrs`	Yes		Comma separated list of IP addresses to probe.
`port`		`47808`	UDP port to probe.
`max_time`		`5min`	Maximum time to spend searching (`1min`-`15min`).

`jasper-scan`

Scans a Niagara instance for Jasper sources.

Parameter	Required	Default	Description
`ip_addr`	Yes		IP address of the Niagara instance.
`credential`	Yes		Name of credential used to connect.
`port`		`443`	TCP port for the Niagara WebService.
`tls`			Use TLS: `true` or `false`.

When tls is not specified it is enabled automatically for ports ending in 443 (i.e.: 443, 8443, 9443) and disabled otherwise. If TLS is enabled, ensure the required certificate is added in Project Settings.

`kaiterra-find`

Finds Kaiterra sources by device identifier.

Parameter	Required	Default	Description
`uuids`	Yes		Comma separated list of Kaiterra device UDIDs.
`credential`	Yes		Name of credential used to access device data.

Returns

Returns the id of the queued operation. Poll Explorer Ops to track it.

{
  "status": "ok",
  "op_id": "0a1b2c3d4e5f6a7b"
}

Errors

Code	Description
400	Unsupported `op`, invalid or missing parameter, or the node or credential could not be resolved.
403	The API key is read-only.
429	The service queue for this project is full. Retry once queued operations complete.

Novant

Documentation