List Targets with Unlimited Scans

GET 
/account/unlimited/

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

label string[]

Target labels to filter results, as a query string. For example, "label=Production" or "label=Production&label=QA".

label_logical_operator string
Possible values: [and, or]
Logical operator to apply between target labels.
• and - and
• or - or
ordering stringrequired

Which field to use when ordering the results.

risk integer[]
Possible values: [0, 10, 20, 30]
Target risk to filter results:
• 10 - Low risk.
• 20 - Medium risk.
• 30 - High risk.
• 0 - Not applicable.
scan_profile string[]

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

search stringrequired

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

200

application/json

Schema

Schema

• Array [
id stringrequired
site objectrequired

Core settings of the target.
Includes basic target information like the name and URL.

id stringrequired

A unique Base58 value identifying this object.

name stringrequired

Possible values: <= 255 characters

Name of the target or extra host.
The maximum length is 255 characters.

url stringrequired

Possible values: <= 2048 characters

URL of the target.

changed date-timerequired

Date and time of the last change, in ISO 8601 UTC format.
For example, "2023-08-09T13:27:43.8208302".

changed_by objectrequired

User who last made changes.

id stringrequired

A unique Base58 value identifying this object.

email emailrequired

Possible values: <= 254 characters

Email of the user.

name stringrequired

Possible values: <= 60 characters

Name of the user.

teams object[]required
Array [
id stringrequired
A unique Base58 value identifying this object.
name stringrequired
]
unlimited booleanrequired

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

• ]

Example (from schema)

[
  {
    "id": "string",
    "site": {
      "id": "string",
      "name": "string",
      "url": "string",
      "changed": "2024-09-10T15:58:28.933Z",
      "changed_by": {
        "id": "string",
        "email": "[email protected]",
        "name": "string"
      }
    },
    "teams": [
      {
        "id": "string",
        "name": "string"
      }
    ],
    "unlimited": true
  }
]

400

application/json

Schema

Schema

<field name> string[]required
non_field_errors string[]required

Example (from schema)

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

401

application/json

Schema

Schema

detail stringrequired

Example (from schema)

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

500

application/json

Schema

Schema

detail stringrequired

Example (from schema)

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

Loading...