Scans

List Target's Scans

Changed on
get/targets/{target_id}/scans/

Request

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

Path parameters

target_idstring required

Identifier of the target.

Query parameters

completed__gtstring date-time

Date and time from which scans completed (exclusively) to filter results, in ISO 8601 UTC format.
For example, “2023-08-09T13:27:43.8208302".

completed__gtestring date-time

Date and time from which scans completed (inclusively) to filter results, in ISO 8601 UTC format.
For example, “2023-08-09T13:27:43.8208302".

completed__ltstring date-time

Date and time until which the scans completed (exclusively) to filter results, in ISO 8601 UTC format.
For example, “2023-08-09T13:27:43.8208302".

completed__ltestring date-time

Date and time until which the scans completed (inclusively) to filter results, in ISO 8601 UTC format.
For example, “2023-08-09T13:27:43.8208302".

excludestring[]

Fields to exclude from the response (e.g. custom_api_parameters).

labelstring[]

A unique Base58 value identifying this object.

lengthinteger

Number of results to return per page.

orderingstring

Which field to use when ordering the results.

pageinteger

A page number within the paginated result set.

partialboolean
scan_profilestring[]

Identifier of the scan profile to filter results.

searchstring

A search term.

started__gtstring date-time

Date and time from which the scans started (exclusively) to filter results, in ISO 8601 UTC format.
For example, “2023-08-09T13:27:43.8208302".

started__gtestring date-time

Date and time from which the scans started (inclusively) to filter results, in ISO 8601 UTC format.
For example, “2023-08-09T13:27:43.8208302".

started__ltstring date-time

Date and time from which the scans started (exclusively) to filter results, in ISO 8601 UTC format.
For example, “2023-08-09T13:27:43.8208302".

started__ltestring date-time

Date and time until which the scans started (inclusively) to filter results, in ISO 8601 UTC format.
For example, “2023-08-09T13:27:43.8208302".

started_afterstring date-time

Date and time of when the scan started to filter results, in ISO 8601 UTC format.
For example, "2023-08-09T13:27:43.8208302"

started_beforestring date-time

Date and time of when the scan started to filter results, in ISO 8601 UTC format.
For example, "2023-08-09T13:27:43.8208302"

statusstring[]

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
targetstring[]

Scan target.

teamstring[]

A unique Base58 value identifying this object.

warningstring[]

Identifiers of warnings to filter results.
Multiple choices are possible by repeating the query_param.

Response

countinteger

Total number of results.

page_totalinteger

Total number of pages.

pageinteger

Number of the current page.
The first page is 1.
Defaults to 1 if no specific page is requested.

lengthinteger

Number of results returned per page.

Example response

{
  "count": 6,
  "page_total": 1,
  "page": 1,
  "length": 10
}

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 new optional query request parameter exclude

    • info

      added the enum value duration_limit_reached to the property items/ of the query request parameter warning

    • info

      added the enum value ntlm_error to the property items/ of the query request parameter warning

    • 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 results/items/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 results/items/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 results/items/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 results/items/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

    • 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