Skip to main content

Generate Report

POST 
/report/

Request​

Body

    severity integer[]

    Filter findings by severity

    state string[]

    Filter findings by state

    assignee string[]

    Filter findings by assignee's user ID

    label string[]

    Filter findings by label ID

    new booleannullable

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

    target_label string[]

    Filter findings by target label ID

    target string[]

    Filter findings by target ID

    team string[]

    Filter findings by team ID

    search string

    Possible values: <= 1024 characters

    Search findings

    assessment string

    Filter findings by assessment ID

    findings string[]

    Filter findings by IDs

    report_type string

    Possible values: [default, executive_summary, owasp, pci, pci4, iso27001, hipaa]

    • default - Standard
    • executive_summary - Executive Summary
    • owasp - OWASP Top 10
    • pci - PCI v3.2.1
    • pci4 - PCI v4.0.1
    • iso27001 - ISO 27001
    • hipaa - HIPAA
    report_fileformat string

    Possible values: [pdf, docx]

    Format for the report to produce.

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

Responses​

Schema

    id stringrequired

    A unique Base58 value identifying this object.

    user stringrequired

    A unique Base58 value identifying this object.

    submitted_at date-timerequired

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

    generated_at date-timenullablerequired

    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_enabled boolean

    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.

    filters stringrequired

    A unique Base58 value identifying this object.

    ttl stringrequired

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

    timezone string

    Possible values: <= 64 characters

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

Loading...