Host Scan Job

Manage jobs that scan hosts.

📄️List the status of all host scan jobs

Returns the status of every host scan job, including the status of each host in the job. Use it to see all scans that are queued, running or finished.

📄️Create host scan jobs for a list of hosts

Creates a scan job for the hosts in the request and returns its status. Use it to onboard new hosts or to scan hosts by name with a service account.

📄️Get the latest scan job status for a host

Returns the status of the most recent host scan job for the given host. Use it to check whether a scan of that host is queued, running or finished.

📄️Scan a known host

Schedules a scan of one host that already exists in the system. The scan uses the resource service account, or the credential saved on the host if the resource has none.

📄️Scan several known hosts

Schedules a scan for each host ID in the list and returns the status of the scan jobs that were created. Hosts that cannot be scheduled, such as unknown hosts or hosts without a service account, are left out of the response without an error.

📄️Cancel a host scan job

Cancels a host scan job. The call returns as soon as the cancellation is accepted, so check the job status afterward to confirm.

📄️Get the status of a host scan job

Returns the status of one host scan job, including the status of each host in the job. Poll this route after you start a scan until the status shows the job has finished.

📄️Scan a resource now

Starts a scan of the host behind a resource, using the resource service account, and returns the scan job status. Use it to refresh what the system knows about a resource right away. In this operation the `hostScanJobId` path segment holds the ID of a managed resource, not the ID of a scan job; the response carries the ID of the new scan job.