PRprobely
Scans

Pause Scan

Changed on
post/targets/{target_id}/scans/{id}/pause/

Request

  • Base URL
    https://api.probely.com
  • URL
    https://api.probely.com/targets/{target_id}/scans/{id}/pause/
  • Auth
    API key in header Authorization

Path parameters

idstring required

A unique Base58 value identifying this object.

target_idstring required

Identifier of the target.

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
event_source'ui' | 'api' | 'cli' | 'sdk' | 'scheduler' | 'integration' | 'backoffice' | 'null' nullable required

How the scan was triggered. null when the scan was created by a Snyk operator (see created_by), since the method isn't meaningful once the operator's identity is already hidden.

  • ui - Started from the Probely web app.
  • api - Started via a direct API call or a CI/CD integration (GitHub Action, Jenkins plugin, CircleCI orb). CI/CD integrations are indistinguishable from direct API calls because they use the same REST API with a regular API key.
  • cli - Started by the Probely CLI.
  • sdk - Started by the Probely SDK.
  • scheduler - Started automatically by the Probely scheduler.
  • integration - Started by an incoming webhook from a third-party integration (Jira, Azure DevOps, Heroku). Does not cover CI/CD pipelines.
  • backoffice - Started by a Probely operator from the internal back-office.
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
sast_job_failure_codestring nullable required
sast_job_repositorystring nullable required
user_datastring

Store scan metadata.

login_videostring required
scheduledboolean required

Scan started by scheduling.

Changes

  • 0b2f6cbe644dRevision changes
    • warning

      removed the optional property ////////// from the response with the status

    • warning

      removed the optional property ////////// from the response with the status

    • warning

      removed the optional property ////////// from the response with the status

    • warning

      removed the optional property ////////// from the response with the status

    • warning

      added the new bruno enum value to the /////////////// response property for the response status

    • warning

      added the new bruno enum value to the ////////// response property for the response status

    • warning

      added the new folder enum value to the /////////////// response property for the response status

    • warning

      added the new folder enum value to the ////////// response property for the response status

    • warning

      added the new interactive_browser enum value to the /////////////// response property for the response status

    • warning

      added the new interactive_browser enum value to the ////////// response property for the response status

    • warning

      added the new repository enum value to the /////////////// response property for the response status

    • warning

      added the new repository enum value to the ////////// response property for the response status

    • warning

      added the new zip enum value to the /////////////// response property for the response status

    • warning

      added the new zip enum value to the ////////// response property for the response status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property /////////////// to the response with the status

    • info

      added the optional property /////////////// to the response with the status

    • info

      added the optional property /////////////// to the response with the status

    • info

      added the optional property /////////////// to the response with the status

    • info

      added the optional property /////////////// to the response with the status

    • info

      added the optional property /////////////// to the response with the status

    • info

      added the optional property ////////// to the response with the status

    • info

      added the optional property ////////// to the response with the status

    • info

      added the optional property ////////// to the response with the status

    • info

      added the optional property ////////// to the response with the status

    • info

      added the optional property ////////// to the response with the status

    • info

      added the optional property ////////// to the response with the status

    • info

      added the optional property ////////// to the response with the status

    • info

      added the optional property ////////// to the response with the status

    • info

      added the optional property ////////// to the response with the status

    • info

      added the optional property ////////// to the response with the status

    • info

      added the optional property ////////// to the response with the status

    • info

      added the optional property ////////// to the response with the status

    • info

      added the optional write-only property target/allOf[SimpleScope]/site/allOf[Target]/api_scan_settings/allOf[APIScanSettings]/snyk_project_id to the response with the status

    • info

      added the optional write-only property target/allOf[SimpleScope]/site/allOf[Target]/api_scan_settings/allOf[APIScanSettings]/staged_collection_id to the response with the status

    • info

      added the optional write-only property target_options/allOf[ScanTargetOptions]/api_scan_settings/allOf[APIScanSettings]/snyk_project_id to the response with the status

    • info

      added the optional write-only property target_options/allOf[ScanTargetOptions]/api_scan_settings/allOf[APIScanSettings]/staged_collection_id to the response with the status

    • info

      added to the ///// response property allOf list for the response status

    • info

      removed from the ///// response property allOf list for the response status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property ////////// to the response with the status

    • info

      added the required property ///////////////// to the response with the status

    • info

      added the required property /////////////// to the response with the status

    • info

      added the required property ////////// to the response with the status

    • info

      added the required property //////////// to the response with the status

    • info

      added the required property ////////// to the response with the status

    • info

      added the required property ////////// to the response with the status

    • info

      added the required property ////////// to the response with the status

    • info

      added the required property ////////// to the response with the status

    • info

      added the required property ////////// to the response with the status

  • e29879bff01bRevision changes
    • warning

      added the new application/graphql enum value to the /////////////// response property for the response status

    • warning

      added the new application/graphql enum value to the ////////// response property for the response status

    • warning

      added the new graphql enum value to the /////////////// response property for the response status

    • warning

      added the new graphql enum value to the ////////// response property for the response status

    • info

      added the optional property /////////////// to the response with the status

    • info

      added the optional property ////////// to the response with the status

    • info

      added the optional property ////////// to the response with the status

    • info

      added the optional property ////////// to the response with the status

    • info

      added the required property ////////// to the response with the status

    • info

      added the required property ////////// to the response with the status