Account

Bulk Update Targets with Unlimited Scans

Changed on
put/account/unlimited/

Request

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

Query parameters

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
orderingstring

Which field to use when ordering the results.

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

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

verifiedboolean

Request body

idstring required
unlimitedboolean

If true, the target has unlimited scans.
If false, scans consume credits.
Learn more about unlimited scans vs scans with credits.
Defaults to true.

Response

idstring required
unlimitedboolean

If true, the target has unlimited scans.
If false, scans consume credits.
Learn more about unlimited scans vs scans with credits.
Defaults to true.

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

    • info

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