Get a scan.

Prev Next
Get
/api/v1/discovery/scans/{id}

Get a scan.

Security
OAuth

OAuth 2.0 client credential flow, see https://datatracker.ietf.org/doc/html/rfc6749#section-4.4.

FlowClient Credentials
Token URLhttps://api.armor.fortanix.com/api/v1/iam/session/oauth2/token
Path parameters
id
string (uuid) Required
Responses
2XX

Success result

object
acct_id
string (uuid)
connection_id
string (uuid)
created_at
string
Pattern^\d{4}\d{2}\d{2}T\d{2}\d{2}\d{2}Z$
Example20170509T070912Z
ended_at
string
Pattern^\d{4}\d{2}\d{2}T\d{2}\d{2}\d{2}Z$
Example20170509T070912Z
group_id
string (uuid)
last_updated_at
string
Pattern^\d{4}\d{2}\d{2}T\d{2}\d{2}\d{2}Z$
Example20170509T070912Z
scan_errors
Array of string | null
string
scan_id
string (uuid)
scan_status
string
Valid values[ "in_progress", "completed", "stopped", "pending", "failed" ]