PRprobely
Reports

Generate Report

Changed on
post/report/

Request

  • Base URL
    https://api.probely.com
  • URL
    https://api.probely.com/report/
  • Auth
    API key in header Authorization

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

snyk_groupstring

Snyk group ID (Snyk-managed accounts): limits the report to the Teams of the group's orgs loaded for the user. With team, only the given Teams that belong to the group are kept.

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'

failed_atstring date-time nullable required

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

errorstring required

Error message if report generation failed.

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

Changes

  • 0b2f6cbe644dRevision changes
    • info

      added the new optional request property (media type: application/json)

    • info

      added the new optional request property (media type: application/x-www-form-urlencoded)

    • info

      added the new optional request property (media type: multipart/form-data)

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

  • e29879bff01bRevision changes
    • info

      added the new owasp_web_2021 enum value to the request property (media type: application/json)

    • info

      added the new owasp_web_2021 enum value to the request property (media type: application/x-www-form-urlencoded)

    • info

      added the new owasp_web_2021 enum value to the request property (media type: multipart/form-data)

    • info

      added the new owasp_web_2025 enum value to the request property (media type: application/json)

    • info

      added the new owasp_web_2025 enum value to the request property (media type: application/x-www-form-urlencoded)

    • info

      added the new owasp_web_2025 enum value to the request property (media type: multipart/form-data)

    • info

      added the new pci_v3_2_1 enum value to the request property (media type: application/json)

    • info

      added the new pci_v3_2_1 enum value to the request property (media type: application/x-www-form-urlencoded)

    • info

      added the new pci_v3_2_1 enum value to the request property (media type: multipart/form-data)

    • info

      added the new pci_v4_0_1 enum value to the request property (media type: application/json)

    • info

      added the new pci_v4_0_1 enum value to the request property (media type: application/x-www-form-urlencoded)

    • info

      added the new pci_v4_0_1 enum value to the request property (media type: multipart/form-data)