Skip to main content
GET
Error

Authorizations

​
Authorization
string
header
required

API token obtained from the Tokens endpoint or CLI device login. Include as Authorization: Bearer <token>. Requests made with a managed CLI session also include X-Strix-Workspace: <organization_id> to pin a process to the workspace it started in; recovery endpoints report the current workspace after a concurrent switch.

Path Parameters

​
scanId
string<uuid>
required

UUID of the scan. Use the id field of a scan from listScans.

Query Parameters

​
format
enum<string>
default:technical

Report format. Formats other than "technical" require an Enterprise plan.

Available options:
technical,
retest,
attestation,
executive_summary
​
type
enum<string>
default:pdf

File type for the rendered report. DOCX requires an Enterprise plan.

Available options:
pdf,
docx
​
providerName
string

White-label provider name shown on the report cover (Enterprise branding). Trimmed to 80 characters.

​
clientName
string

Client name the report is prepared for, shown in place of the organization name (Enterprise branding). Trimmed to 120 characters.

​
memberName0
string

Name of the first "prepared by" team member for white-label branding. Trimmed to 120 characters.

​
memberEmail0
string<email>

Email of the first "prepared by" team member for white-label branding. Trimmed to 120 characters.

​
memberName1
string

Name of the second "prepared by" team member for white-label branding. Trimmed to 120 characters.

​
memberEmail1
string<email>

Email of the second "prepared by" team member for white-label branding. Trimmed to 120 characters.

Response

Report file. Content type is application/pdf by default, or the DOCX media type when type=docx.

The response is of type file.