Sign in

v1

latestOpenAPI 3.0.32026-07-134103031.5 MB
Targets

Import Targets

The upload functionality allows the automatic creation of new targets from multiple file formats (.yaml, .csv, .json).

And one can optionally add scheduled scan data when uploading target data.

The following are the required internal data structures.

CSV data

The fields about scheduled scan data can be left empty if not necessary.

"name","url","scan_profile","scheduledscan_datetime","scheduledscan_recurrence","labels"
"My target","https://mytarget.url.com","Normal","2022-12-30T12:34:56.224739","m","['label1', 'label2']"
"My other target","https://www.mytargetsite2.com","Normal","","","['label3', 'label2']"

YAML data

- name: My target
    site:
        name: My target site
        desc: My target site description
        url: https://mytarget.url.com
        # optional site fields
        form_login_url: https://mytarget.url.com/login
        form_login_check_pattern: ""
        form_login: []
        headers: []
        cookies: []
        whitelist: []
    scan_profile: normal
    type: single
    # optional target fields
    report_type: default
    # optional scheduled_scan data
    scheduled_scan:
        date_time: "2022-12-30T12:34:56.224739"
        recurrence: "d"
        timezome: "Europe/Madrid"

JSON data

Data format with nested ScheduledScan data:

[
    {
        "name": "My target",
        "site": {
            "name": "My target site",
            "desc": "My target description",
            "url": "https://mytarget.url.com",
            # optional site fields
            "form_login_url": "https://mytarget.url.com/login,
            "form_login_check_pattern": "",
            "form_login": [],
            "headers": [],
            "cookies": [],
            "whitelist": []
        },
        "scan_profile": "Normal",
        // optional scheduled_scan data
        "scheduled_scan": {
            "date_time": "2022-12-30T12:34:56.224739",
            "recurrence": "d",
            "timezone": "Europe/Madrid"
        }
    }
]

Data format with flat ScheduledScan data:

[
    {
        "name": "My target",
        "site": {
            "name": "My target site",
            "desc": "My target description",
            "url": "https://mytarget.url.com"
            # optional site fields
            "form_login_url": "https://mytarget.url.com/login,
            "form_login_check_pattern": "",
            "form_login": [],
            "headers": [],
            "cookies": [],
            "whitelist": []
        },
        "scan_profile": "Normal",
        // optional scheduled_scan data
        "scheduledscan_datetime": "2022-12-30T12:34:56.224739",
        "scheduledscan_recurrence": "m"
    },
]
post/targets/upload/

Request body

idstring required

A unique Base58 value identifying this object.

lowsinteger nullable required

Number of unresolved vulnerability findings with low severity.

mediumsinteger nullable required

Number of unresolved vulnerability findings with medium severity.

highsinteger nullable required

Number of unresoved vulnerability findings with high severity.

criticalsinteger nullable required

Number of unresolved vulnerability findings with critical severity.

riskinteger nullable required
scan_profilestring

Identifier of the scan profile.

typestring

Type of target.
Possible values are "single" for a web application and "api" for an API.
Defaults to "single".

unlimitedboolean

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

report_type'default' | 'executive_summary' | 'owasp' | 'owasp_web_2021' | 'owasp_web_2025' | 'pci' | 'pci_v3_2_1' | 'pci4' | 'pci_v4_0_1' | 'iso27001' | 'hipaa'

Type of scan report produced for the target:
(Defaults to default)

  • default - Standard
  • executive_summary - Executive Summary
  • owasp - OWASP Top 10 2021
  • owasp_web_2021 - OWASP Top 10 2021
  • owasp_web_2025 - OWASP Top 10 2025
  • pci - PCI DSS 3.2.1
  • pci_v3_2_1 - PCI DSS 3.2.1
  • pci4 - PCI DSS 4.0.1
  • pci_v4_0_1 - PCI DSS 4.0.1
  • iso27001 - ISO 27001
  • hipaa - HIPAA
report_fileformat'pdf' | 'docx'

Report format for the target:
(Defaults to pdf)

  • pdf - PDF file format.
  • docx - DOCX file format.
include_deduplicated_endpointsboolean nullable

If true, scans include deduplicated endpoints.
If false or null, scans exclude deduplicated endpoints.
A deduplicated endpoint has the same simhash as another scanned endpoint.

fail_fastboolean

If true, scans fail on recoverable errors.
If false, scans continue on recoverable errors.
Defaults to true.

login_videostring required
changedstring date-time required

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

incrementalboolean

If true, on-demand scans can be incremental to narrow the coverage to new and updated URLs.
Learn more about partial scans.
Defaults to false.

reduced_scopeboolean

If true, on-demand scans can have reduced scope to narrow the coverage to defined URLs.
Learn more about partial scans.
Defaults to false.

schedule_incrementalboolean

If true, scheduled scans can be incremental to narrow the coverage to new and updated URLs.
Learn more about partial scans.
Defaults to false.

schedule_reduced_scopeboolean

If true, scheduled scans can have reduced scope to narrow the coverage to defined URLs.
Learn more about partial scans.
Defaults to false.

crawl_sequences_onlyboolean

If true, on-demand scans can only crawl navigation sequences to narrow the coverage.
Learn more about partial scans.
Defaults to false.

schedule_crawl_sequences_onlyboolean

If true, scheduled scans can only crawl navigation sequences to narrow the coverage.
Learn more about partial scans.
Defaults to false.

cancel_scan_on_nav_seq_failureboolean

If true, scans are canceled if one of the navigation sequences fails. Defaults to false.

Response

target_idsstring[]
scan_idsstring[]

Example response

{
  "target_ids": [
    "<target id>"
  ],
  "scan_ids": [
    "<target id>"
  ]
}