Start a discovery scan
POST/api/v1/orgs/:org/discovery/scans
Admin only. The generic body is {type, parameters}; the discovery-type
registry validates the parameters and resolves the job to enqueue. For LAN,
parameters are {cidrs, ports?, concurrency?, timeout?}; for Freebox,
{channelUid}; for Container, {hosts, timeout?} where each host is a
Docker-compatible endpoint (unix:// or tcp://); for Kubernetes,
{clusterUid, namespaces?, timeout?} where clusterUid references a
stored Kubernetes cluster connection (empty namespaces scans every
visible namespace).
Request
Responses
- 201
- 400
- 403
- 404
- 409
- 422
Scan started
Unknown discovery type (DISCOVERY_UNKNOWN_TYPE)
Permission denied
The referenced Kubernetes cluster connection was not found (KUBERNETES_CLUSTER_NOT_FOUND)
A scan of this type is already running (DISCOVERY_ALREADY_RUNNING), or a Freebox channel is not paired (FREEBOX_NOT_GRANTED)
Invalid parameters (DISCOVERY_INVALID_PARAMETERS) or range too large (DISCOVERY_RANGE_TOO_LARGE)