Bulk Update Targets with Unlimited Scans

PUT 
https://api.probely.com/account/unlimited/

Request

Query Parameters

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
ordering string

Which field to use when ordering the results.

risk integer[]
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.
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

application/json

Body

required

• Array [

id stringrequired
unlimited boolean

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

• ]

application/x-www-form-urlencoded

Body

required

• Array [

id stringrequired
unlimited boolean

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

• ]

multipart/form-data

Body

required

• Array [

id stringrequired
unlimited boolean

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

• ]

Responses

200

application/json

Schema

Schema

• Array [

id stringrequired

site

object

required

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

id stringrequired

A unique Base58 value identifying this object.

name string

Possible values: <= 255 characters

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

url string

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

object

required

User who last made changes.

id stringrequired

A unique Base58 value identifying this object.

email email

Possible values: <= 254 characters

Email of the user.

name stringrequired

Possible values: <= 60 characters

Name of the user.

teams

object[]

required

Array [

id string

A unique Base58 value identifying this object.

name stringrequired

]

unlimited boolean

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-07-29T15:51:28.071Z",
      "changed_by": {
        "id": "string",
        "email": "user@example.com",
        "name": "string"
      }
    },
    "teams": [
      {
        "id": "string",
        "name": "string"
      }
    ],
    "unlimited": true
  }
]

400

application/json

Schema

Schema

<field name> string[]
non_field_errors string[]

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 string

Example (from schema)

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

500

application/json

Schema

Schema

detail string

Example (from schema)

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

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L -X PUT 'https://api.probely.com/account/unlimited/' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: JWT <YOUR_API_TOKEN>' \
-d '[
  {
    "id": "string",
    "unlimited": true
  }
]'

Request Collapse all

Base URL

https://api.probely.com

Auth

JWT Authentication

Parameters

exclude_team — query

id — query

label — query

label_logical_operator — query

---andor

ordering — query

risk — query

0102030

scan_profile — query

search — query

team — query

type — query

unlimited — query

---truefalse

verified — query

---truefalse

Body required

Content-Type

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

[
  {
    "id": "string",
    "unlimited": true
  }
]

ResponseClear

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