PRprobely
Scan Profiles

Bulk Update Custom Scan Profiles

Changed on

Update multiple Custom Scan Profiles in one operation.
Mainly used to archive, or unarchive, several scan profiles at once.
Targets and recurrent scheduled scans using an archived scan profile are reassigned to the default scan profile.
Built-in scan profiles cannot be updated.

post/scan-profiles/bulk/update/

Request

  • Base URL
    https://api.probely.com
  • URL
    https://api.probely.com/scan-profiles/bulk/update/
  • Auth
    API key in header Authorization

Query parameters

is_id_404_validationboolean

If true, triggers custom response for ids payload validation.
If any ids payload is invalid, returns a 404 with the following content:

{
    "detail": "Not Found",
    "is_id_404_validation": true,
    "invalid_ids": [
        "9vebyEVLNoZX",
        "6CuzJtJmMp48"
    ]
}

Request body

idsstring[] required

List of the identifiers of the scan profiles to update.

namestring

Name of the scan profile.
The maximum length is 255 characters.

descriptionstring nullable

Description of the scan profile.

archivedboolean

If true, the scan profile is no longer in use.
If false, the scan profile can be used.

type'web' | 'api'

Target type:

  • web - Scan a Web application, including Single Page Applications (SPA) that rely on one or more APIs.
  • api - Scan a standalone API defined by an OpenAPI schema, or by a Postman Collection.
speed10 | 20 | 30

Scan speed:
(Defaults to 20)

  • 10 - Slow - Does roughly half the number of parallel requests of the Normal speed.
  • 20 - Normal - Offers a good balance between scan duration and the number of requests performed at the same time to the target.
  • 30 - Fast - Does roughly twice the number of parallel requests of the Normal speed.
payloads10 | 20 | 30

Scan payloads:
(Defaults to 20)

  • 10 - Light - Uses slightly less payloads than Normal, reducing scan time while still detecting the most common situations.
  • 20 - Normal - Uses a set of payloads that maximizes detection without increasing the scan time excessively, delivering a good compromise.
  • 30 - Thorough - Includes a more extensive set of payloads to detect very uncommon situations. Scan time increases significantly.
methods'all' | 'safe' | ''

Scan methods:
(Defaults to all)

  • all - All methods - Allow any HTTP method to be used during the scan.
  • safe - Only safe methods - Ideal set for production targets, allowing only the following HTTP methods: GET, HEAD, OPTIONS, TRACE, and CONNECT.
delayinteger nullable

Time delay in milliseconds between requests for each scanning thread.
It is an approximate value and is more accurate for slower scan speed settings.
If not defined, there is no delay between requests.
The maximum delay is 5000ms.

dedup_enabledboolean

If true, the scan deduplicates pages with the same SimHash to scan only a few of them.
If false, the scan does not deduplicate pages, which can increase the scan duration significantly.
Defaults to true.

auto_patterns_enabledboolean

If true, the scan detects URL patterns to identify similar pages to scan only a few of them.
If false, the scan does not detect patterns, which can increase the scan duration significantly. Defaults to true.

max_urlsinteger

Maximum number of URLs the crawler can visit.
The value must be between 1 and 50000.
Defaults to 5000, which is a good compromise between coverage and scan time.

Response

idsstring[] required

List of object IDs.

Changes