Sign in
Discoveries
internal

Receive discovery progress update from daemon

Internal endpoint for daemons to report discovery progress.

post/api/v1/discovery/{session_id}/update

Path parameters

session_idstring uuid required

Discovery session ID

Request body

daemon_idstring uuid required

The daemon this entity refers to.

discovery_idstring uuid nullable

The discovery configuration this session belongs to. Always enriched server-side; daemons do not send this field.

errorstring nullable

Failure message, when the run did not complete.

estimated_remaining_secsinteger nullable

Rough estimate of the time left, in seconds.

finished_atstring date-time nullable

When the run finished. null while it is still going.

hosts_discoveredinteger nullable

Hosts found so far.

network_idstring uuid required

The network this entity belongs to.

phase'AwaitingSnapshot' | 'Queued' | 'Pending' | 'Starting' | 'Started' | 'Scanning' | 'Complete' | 'Failed' | 'Cancelled' required
progressinteger required

Completion of the current phase, from 0 to 1.

session_idstring uuid required

The discovery run this update belongs to.

started_atstring date-time nullable

When the run started.

Response

Update received

dataTupleUnit

No payload. Present only so the envelope keeps its shape.

errorstring nullable

Human-readable failure message. Omitted on success.

successboolean required

true when the request succeeded. false responses carry error instead of data.

Example response

{
  "meta": {
    "api_version": 1,
    "server_version": "0.17.13"
  }
}

Changes