Generate Report
POST/report/
Request
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
Body
default
- Standardexecutive_summary
- Executive Summaryowasp
- OWASP Top 10pci
- PCI v3.2.1pci4
- PCI v4.0.1iso27001
- ISO 27001hipaa
- HIPAApdf
- PDF file format.docx
- DOCX file format.
Filter findings by severity
Filter findings by state
Filter findings by assignee's user ID
Filter findings by label ID
If true, filter results by new findings.
If false, filter results by old findings.
Filter findings by target label ID
Filter findings by target ID
Filter findings by team ID
Possible values: <= 1024 characters
Search findings
Filter findings by assessment ID
Filter findings by IDs
Possible values: [default
, executive_summary
, owasp
, pci
, pci4
, iso27001
, hipaa
]
Possible values: [pdf
, docx
]
Format for the report to produce.
Body
default
- Standardexecutive_summary
- Executive Summaryowasp
- OWASP Top 10pci
- PCI v3.2.1pci4
- PCI v4.0.1iso27001
- ISO 27001hipaa
- HIPAApdf
- PDF file format.docx
- DOCX file format.
Filter findings by severity
Filter findings by state
Filter findings by assignee's user ID
Filter findings by label ID
If true, filter results by new findings.
If false, filter results by old findings.
Filter findings by target label ID
Filter findings by target ID
Filter findings by team ID
Possible values: <= 1024 characters
Search findings
Filter findings by assessment ID
Filter findings by IDs
Possible values: [default
, executive_summary
, owasp
, pci
, pci4
, iso27001
, hipaa
]
Possible values: [pdf
, docx
]
Format for the report to produce.
Body
default
- Standardexecutive_summary
- Executive Summaryowasp
- OWASP Top 10pci
- PCI v3.2.1pci4
- PCI v4.0.1iso27001
- ISO 27001hipaa
- HIPAApdf
- PDF file format.docx
- DOCX file format.
Filter findings by severity
Filter findings by state
Filter findings by assignee's user ID
Filter findings by label ID
If true, filter results by new findings.
If false, filter results by old findings.
Filter findings by target label ID
Filter findings by target ID
Filter findings by team ID
Possible values: <= 1024 characters
Search findings
Filter findings by assessment ID
Filter findings by IDs
Possible values: [default
, executive_summary
, owasp
, pci
, pci4
, iso27001
, hipaa
]
Possible values: [pdf
, docx
]
Format for the report to produce.
Responses
- 200
- 400
- 401
- 404
- 500
- application/json
- Schema
- Example (from schema)
Schema
A unique Base58 value identifying this object.
A unique Base58 value identifying this object.
Report request submission date.
Report request generation date.
A unique Base58 value identifying this object.
Possible values: <= 64 characters
IANA time zone name (e.g., 'America/New_York', 'Europe/London').
{
"id": "string",
"user": "string",
"submitted_at": "2024-07-29T15:51:28.071Z",
"generated_at": "2024-07-29T15:51:28.071Z",
"is_email_notification_enabled": true,
"filters": "string",
"ttl": "string",
"timezone": "string"
}
- application/json
- Schema
- Example (from schema)
Schema
{
"<field name>": [
"Errors related to field <field name>."
],
"non_field_errors": [
"Errors not related to any field specific field."
]
}
- application/json
- Schema
- Example (from schema)
Schema
{
"detail": "Incorrect authentication credentials."
}
- application/json
- Schema
- Example (from schema)
Schema
{
"detail": "Not found."
}
- application/json
- Schema
- Example (from schema)
Schema
{
"detail": "Unexpected error while handling your request."
}