Skip to main content
POST
Scan

Response

200 - application/json

Successful Response

Response for POST /admin/api/v1/onboarding/scan.

The five-state classification is computed server-side from the scan result plus the agent row's existence. current_agent is only populated when state == "ALREADY_CONFIGURED".

state
enum<string>
required
Available options:
EMPTY,
NO_SUPPORTED,
ONE_DETECTED,
MANY_DETECTED,
ALREADY_CONFIGURED
scanResult
ScanResult · object
required

Aggregate result of a single scan_folder call.

currentAgent
StandaloneAgentRead · object | null

GET response and the data payload of PATCH responses.

Last modified on May 22, 2026