Sign in

v1

latestOpenAPI 3.0.32026-07-134103031.5 MB
Reports

Generate Report

post/report/

Request body

severityinteger[]

Filter findings by severity

statestring[]

Filter findings by state

assigneestring[]

Filter findings by assignee's user ID

labelstring[]

Filter findings by label ID

newboolean nullable

If true, filter results by new findings.
If false, filter results by old findings.

target_labelstring[]

Filter findings by target label ID

targetstring[]

Filter findings by target ID

teamstring[]

Filter findings by team ID

searchstring

Search findings

assessmentstring

Filter findings by assessment ID

findingsstring[]

Filter findings by IDs

report_type'default' | 'executive_summary' | 'owasp' | 'owasp_web_2021' | 'owasp_web_2025' | 'pci' | 'pci_v3_2_1' | 'pci4' | 'pci_v4_0_1' | 'iso27001' | 'hipaa'
  • 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'

Format for the report to produce.

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

Response

idstring required

A unique Base58 value identifying this object.

userstring required

A unique Base58 value identifying this object.

submitted_atstring date-time required

Date and time of the report submission date, in ISO 8601 UTC format.
For example, '2023-08-09T13:27.43.8208302'

generated_atstring date-time nullable required

Date and time when the report file was generated, in ISO 8601 UTC format.
For example, '2023-08-09T13:27.43.8208302'

is_email_notification_enabledboolean

If true, email notifications are enabled, and the report will be sent to the user via email. If false, email notifications are disabled. Defaults to false.

filtersstring required

A unique Base58 value identifying this object.

ttlstring required

The time-to-live (TTL) for the report file, indicating how long it remains available.

timezonestring

Time zone name according to the IANA standard (e.g., 'America/New_York', 'Europe/London').