v1

latestOpenAPI 3.0.32026-07-134103031.5 MB
Targets

List Targets

get/targets/

Query parameters

excludestring[]

Fields to exclude from the response.

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.

searchstring

A search term.

teamstring

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

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.