Sign in

v1

latestOpenAPI 3.0.32026-07-134103031.5 MB
Scans

Partial Update Scan

patch/targets/{target_id}/scans/{id}/

Path parameters

idstring required

A unique Base58 value identifying this object.

target_idstring required

Identifier of the target.

Request body

idstring

A unique Base58 value identifying this object.

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.

scan_profilestring

Identifier of the scan profile.

lowsinteger nullable

Number of vulnerability findings with low severity.

mediumsinteger nullable

Number of vulnerability findings with medium severity.

highsinteger nullable

Number of vulnerability findings with high severity.

criticalsinteger nullable

Number of vulnerability findings with critical severity.

createdstring date-time
unlimitedboolean

If true, the scan had unlimited credits. If false, the scan consumed credits. Learn more about unlimited scans vs scans with credits.

changedstring date-time

Date and time of the last change, in ISO 8601 UTC format.
For example, "2023-08-09T13:27:43.8208302".

has_sequence_navigationboolean

If true, the scan includes sequence navigations.
Learn more about How to set up Navigation Sequences?.

incrementalboolean

If true, the scan was incremental to narrow the coverage to new and updated URLs.
Learn more about partial scans.

reduced_scopeboolean

If true, the scan used a reduced scope to narrow the coverage to defined URLs.
Learn more about partial scans.

crawl_sequences_onlyboolean

If true, the scan only crawled navigation sequences to narrow the coverage.
Learn more about partial scans.

ignore_blackout_periodboolean

If true, the scan ignored the blackout period defined in the target settings.

runtimestring

Total time the scan has been actively running.
For example, "02 00:00:10.123456".

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".

sast_job_idstring nullable
sast_job_statusstring nullable
user_datastring

Store scan metadata.

login_videostring
scheduledboolean

Scan started by scheduling.

Response

idstring required

A unique Base58 value identifying this object.

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

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 required

Date and time of when the scan started.

completedstring date-time nullable required

Date and time of when the scan was completed.

scan_profilestring required

Identifier of the scan profile.

lowsinteger nullable required

Number of vulnerability findings with low severity.

mediumsinteger nullable required

Number of vulnerability findings with medium severity.

highsinteger nullable required

Number of vulnerability findings with high severity.

criticalsinteger nullable required

Number of vulnerability findings with critical severity.

createdstring date-time required
unlimitedboolean required

If true, the scan had unlimited credits. If false, the scan consumed credits. Learn more about unlimited scans vs scans with credits.

changedstring date-time required

Date and time of the last change, in ISO 8601 UTC format.
For example, "2023-08-09T13:27:43.8208302".

has_sequence_navigationboolean

If true, the scan includes sequence navigations.
Learn more about How to set up Navigation Sequences?.

incrementalboolean required

If true, the scan was incremental to narrow the coverage to new and updated URLs.
Learn more about partial scans.

reduced_scopeboolean required

If true, the scan used a reduced scope to narrow the coverage to defined URLs.
Learn more about partial scans.

crawl_sequences_onlyboolean required

If true, the scan only crawled navigation sequences to narrow the coverage.
Learn more about partial scans.

ignore_blackout_periodboolean required

If true, the scan ignored the blackout period defined in the target settings.

runtimestring

Total time the scan has been actively running.
For example, "02 00:00:10.123456".

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".

sast_job_idstring nullable required
sast_job_statusstring nullable required
user_datastring

Store scan metadata.

login_videostring required
scheduledboolean required

Scan started by scheduling.