Reports

The partner API's one report endpoint and what it returns.

The partner API has one report endpoint: GET /api/v1/engagements/{engagement_id}/report.

curl -H "X-API-Key: $PENTR_API_KEY" \
  https://<pentr-host>/api/v1/engagements/$ENGAGEMENT_ID/report

It returns the record of the engagement's newest report:

{
  "id": "d3089d1c-98f8-4626-b54a-95387b2e6b88",
  "engagement_id": "8e20bac6-6464-48a2-86d8-864089f432c6",
  "file_path": "/api/engagements/8e20bac6-6464-48a2-86d8-864089f432c6/reports/d3089d1c-98f8-4626-b54a-95387b2e6b88/download",
  "created_at": "2026-09-02T00:00:00"
}

file_path is the console's download path for the report. It is served by the console's UI API and requires a signed-in console session; it cannot be fetched with an API key.

A report exists only once it has been generated in the console, which happens for a completed engagement. Until then the endpoint answers 404:

{"detail": "No report available"}

An engagement that does not exist, or belongs to another organization, is answered 404 Engagement not found.

The partner API has no endpoint that generates a report, selects a format or downloads a report file. Findings & reports describes what a report contains.

Last updated 2026-09-23