List Targets

GET https://api.probely.com/profile/targets/

Request

Query Parameters

enabled boolean

exclude_team string[]

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

id string[]

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

label string[]

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

label_logical_operator string

Possible values: [and, or]

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

and - and
or - or

length integer

Number of results to return per page.

ordering string

Which field to use when ordering the results.

page integer

A page number within the paginated result set.

risk string[]

Possible values: [0, 10, 20, 30, null]

Target risk to filter results:

None - Not applicable.
0 - No risk.
10 - Low risk.
20 - Medium risk.
30 - High risk.

role string[]

scan_profile string[]

Identifiers of the scan profiles to filter results, separated by commas.

search string

A search term.

team string[]

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

type string[]

unlimited boolean

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

verified boolean

Responses

application/json

Schema
Example (from schema)

Schema

count integer

Total number of results.

page_total integer

Total number of pages.

page integer

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

length integer

Number of results returned per page.

results

object[]

{
  "count": 6,
  "page_total": 1,
  "page": 1,
  "length": 10,
  "results": [
    {
      "id": "string",
      "site": {
        "id": "string",
        "name": "string",
        "url": "string",
        "changed": "2024-07-29T15:51:28.071Z",
        "changed_by": {
          "id": "string",
          "email": "user@example.com",
          "name": "string"
        }
      },
      "user_roles": "string",
      "changed": "2024-07-29T15:51:28.071Z",
      "changed_by": {
        "id": "string",
        "email": "user@example.com",
        "name": "string"
      }
    }
  ]
}

application/json

Schema
Example (from schema)

Schema

<field name> string[]

non_field_errors string[]

{
  "<field name>": [
    "Errors related to field <field name>."
  ],
  "non_field_errors": [
    "Errors not related to any field specific field."
  ]
}

application/json

Schema
Example (from schema)

Schema

detail string

{
  "detail": "Incorrect authentication credentials."
}

application/json

Schema
Example (from schema)

Schema

detail string

{
  "detail": "Unexpected error while handling your request."
}

CURL

curl -L 'https://api.probely.com/profile/targets/' \
-H 'Accept: application/json' \
-H 'Authorization: JWT <YOUR_API_TOKEN>'

ResponseClear

Click the Send API Request button above and see the response here!

List Targets

https://api.probely.com/profile/targets/

Request​

Query Parameters

Responses​

Request

Responses