Sign in

v1

latestOpenAPI 3.0.32026-07-134103031.5 MB
Targets

Upload API Schema File

post/targets/{id}/upload_api_schema_file/

Path parameters

idstring required

A unique Base58 value identifying this object.

Response

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