Retrieve the scan status of an external group.

  • Published on Jul 8, 2025
  • 1 minute(s) read
Prev Next
Get
/sys/v1/groups/{group_id}/hmg/scans

Retrieve the scan status of an external group.

Security
HTTP
Type bearer
API Key: apiKeyAuth
Header parameter nameAuthorization
Path parameters
group_id
string (uuid) Required
Responses
2XX

Success result

Expand All
object
items
Array of object (Scan)

List of all tracked scans, from newest to oldest.

object
scan_id
string (uuid)

The ID of the scan.

is_async
boolean

Whether the scan is async or not.

started_at
string

The time the scan began.

Pattern^\d{4}\d{2}\d{2}T\d{2}\d{2}\d{2}Z$
Example20170509T070912Z
finished_at
string

The time the scan finished.

Pattern^\d{4}\d{2}\d{2}T\d{2}\d{2}\d{2}Z$
Example20170509T070912Z
scan_result

The result of a scan.

OneOf
object
object
$type
string
Valid values[ "Success" ]
object
object
$type
string
Valid values[ "Failed" ]
message
string
warnings
Array of object (ScanWarning) | null

Any warnings thrown during the scan.

object
source_key_id
string (uuid) | null

The ID of the source key for which the warning applies to.

virtual_key_id
string (uuid) | null

The ID of the virtual key for which the warning applies to.

message
string

The warning message associated with the warning.