PRprobely
Targets

List Targets

Changed on
get/targets/

Request

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

Query parameters

excludestring[]

Fields to exclude from the response. Supports top-level fields and nested fields such as custom_api_parameters (from site.api_scan_settings). Use exclude=custom_api_parameters to omit large custom variable values and improve response times for targets with large API parameter payloads.

exclude_teamstring

Names of the teams to exclude from results, as a query string. For example, "exclude_team=Frontend" or "exclude_team=Frontend&exclude_team=Backend".

idstring[]

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

is_id_404_validationboolean

If true, triggers custom response for id filter validation.
If any id filter is invalid, returns a 404 with the following content:

{
    "detail": "Not Found",
    "is_id_404_validation": true,
    "invalid_ids": [
        "9vebyEVLNoZX",
        "6CuzJtJmMp48"
    ]
}
labelstring

Target label IDs to filter results, as a query string.

label_logical_operator'and' | 'or'

Logical operator to apply between target labels.
(Defaults to or)

  • and - and
  • or - or
lengthinteger

Number of results to return per page.

ordering'changed' | 'latest_scan_date' | 'name' | 'risk' | 'target__name'

Which field to use when ordering the results.
Ascending order is the default. For descending order, prefix the field with -.
For example, latest_scan_date and -latest_scan_date.
Field to order by:

  • target__name
  • risk
  • latest_scan_date
  • changed
  • name
pageinteger

A page number within the paginated result set.

riskinteger[]

Target risk to filter results:

  • None - Not applicable.
  • 0 - No risk.
  • 10 - Low risk.
  • 20 - Medium risk.
  • 30 - High risk.
  • 40 - Critical risk.
scan_profilestring[]

Identifier of the scan profile to filter results.

scan_statusstring[]

Status of the target's most recent scan. Multiple choices are possible by repeating the query param. To find targets that have never been scanned, use risk=null.

  • canceled - Canceled
  • canceling - Canceling
  • completed - Completed
  • failed - Failed
  • paused - Paused
  • pausing - Pausing
  • queued - Queued
  • resuming - Resuming
  • started - Started
  • under_review - Under Review
scanning_agentstring[]

Scanning agent IDs to filter results, as a query string. Use none to filter targets with no scanning agent.

searchstring

A search term.

snyk_groupstring

Snyk group ID (Snyk-managed accounts): targets of the group's orgs loaded for the requesting user, i.e. those listed by GET /snyk/groups/{group_id}/orgs/. Matches nothing until the group's orgs have been listed.

teamstring

Names of the teams to filter results, as a query string.
For example, "team=Frontend" or "team=Frontend&team=Backend".

technologystring[]

Technology IDs to filter results, as a query string. Matches targets with any of the given technologies. Use none to filter targets with no technologies.

typestring

Type of target to filter results.
Possible values are "single" for a web application and "api" for an API.

unlimitedboolean

If true, filter results by targets with unlimited scans.
If false, filter results by targets that use credits.

verifiedboolean

If true, filter results by verified targets.
If false, filter results by unverified targets.

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.

Changes

  • 0b2f6cbe644dRevision changes
    • breaking

      the //// response's property type changed from no type to object for 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

      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 scan_status

    • info

      added the new optional query request parameter scanning_agent

    • info

      added the new optional query request parameter snyk_group

    • info

      added the new optional query request parameter technology

    • 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

      the response optional property // became read-only for the status

    • info

      added the optional write-only property results/items/next_scan/allOf[ScheduledScan]/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/next_scan/allOf[ScheduledScan]/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/site/api_scan_settings/allOf[APIScanSettings]/snyk_project_id to the response with the status

    • info

      added the optional write-only property results/items/site/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

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

    • info

      the response property // became required for 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

    • 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

    • warning

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

    • warning

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

    • warning

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

    • warning

      added the new pci_v4_0_1 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