PRprobely
User Management

List Targets

Changed on
get/users/{user_id}/targets/

Request

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

Path parameters

user_idstring required

Query parameters

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

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.

orderingstring

Which field to use when ordering the results.

pageinteger

A page number within the paginated result set.

riskstring[]

Target risk to filter results:

  • None - Not applicable.
  • 0 - No risk.
  • 10 - Low risk.
  • 20 - Medium risk.
  • 30 - High risk.
  • 40 - Critical risk.
rolestring[]
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[]
unlimitedboolean

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

verifiedboolean

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

  • 0b2f6cbe644dRevision changes
    • 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

  • 0e9b5b5da4d0Revision changes
    • info

      added the enum value 40.00 to the property items/ of the query request parameter risk