Skip to main content
POST
/
reports
Create a report
curl --request POST \
  --url https://app.pentest-tools.com/api/v2/reports \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "format": "pdf",
  "group_by": "target",
  "source": "scans",
  "resources": [
    123
  ],
  "filters": {
    "include_finding_history": false,
    "include_all_targets": false,
    "include_how_to_reproduce": true,
    "include_false_positives": false,
    "include_info": true,
    "include_not_verified": true,
    "include_ignored": false,
    "include_accepted": true,
    "include_fixed": true,
    "include_tool_configuration": true
  },
  "webhook_url": "<string>"
}
'
{
  "report_id": 123456
}

Authorizations

​
Authorization
string
header
required

Use the "API key" from the profile page as the token

Body

application/json
​
format
enum<string>
required
Available options:
pdf,
html,
json,
csv,
xlsx,
docx
​
group_by
enum<string>
required
Available options:
target,
vulnerability
​
source
enum<string>
required
Available options:
scans,
findings
​
resources
integer[]
required

The IDs of the resources to include in the report. Use finding IDs if the source parameter is set to findings, or scan IDs if the source parameter is set to scans.

​
filters
object
​
webhook_url
string<url> | null

Response

Accepted

​
report_id
integer

The ID of the report that is being generated

Example:

123456