Preflight

Retrieve Pre-scan Configuration Status

Changed on

Returns the current pre-flight scan configuration status.

get/targets/{id}/pre-scan-configuration/

Request

  • Base URL
    https://api.probely.com
  • URL
    https://api.probely.com/targets/{id}/pre-scan-configuration/
  • Auth
    API key in header Authorization

Path parameters

idstring required

Response

status'canceled' | 'canceling' | 'completed' | 'completed_with_errors' | 'failed' | 'paused' | 'pausing' | 'queued' | 'resuming' | 'started' | 'under_review' | 'finishing_up'

Status of the scan:

  • canceled - Canceled
  • canceling - Canceling
  • completed - Completed
  • completed_with_errors - Completed with errors - DEPRECATED
  • failed - Failed
  • paused - Paused
  • pausing - Pausing
  • queued - Queued
  • resuming - Resuming
  • started - Started
  • under_review - Under Review
  • finishing_up - Finishing up
startedstring date-time nullable

Date and time of when the scan started.

completedstring date-time nullable

Date and time of when the scan was completed.

durationstring

Total time from the start of the scan to its completion, or to the moment of the query, if not completed. For example, "02 00:00:10.123456".

login_videostring nullable required
target_responsestring nullable required

Changes