Scans

Export scan report as a download link

Generate a report for a completed scan and return a short-lived signed download link instead of the file. Same options and plan requirements as GET /scans/{scanId}/report; use this from clients that cannot receive a file, such as the Strix MCP. The link expires after one hour and the file is deleted shortly after. Report downloads require an Enterprise plan. On Pro, each organization can download one technical PDF report for free; it stays free to re-download for that scan.

POST

scans

{scanId}

report

exports

Error

A valid request URL is required to generate request examples

{
  "export": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "scan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "format": "technical",
    "file_type": "pdf",
    "filename": "<string>",
    "content_type": "<string>",
    "size_bytes": 123,
    "url": "<string>",
    "expires_at": "2023-11-07T05:31:56Z"
  }
}

{
  "detail": "<string>",
  "code": "<string>",
  "required_scope": "scans:read",
  "docs": "<string>",
  "hint": "<string>"
}

{
  "detail": "<string>",
  "code": "<string>",
  "required_scope": "scans:read",
  "docs": "<string>",
  "hint": "<string>"
}

{
  "detail": "<string>",
  "code": "<string>",
  "required_scope": "scans:read",
  "docs": "<string>",
  "hint": "<string>"
}

{
  "detail": "<string>",
  "code": "<string>",
  "required_scope": "scans:read",
  "docs": "<string>",
  "hint": "<string>"
}

{
  "detail": "<string>",
  "code": "<string>",
  "required_scope": "scans:read",
  "docs": "<string>",
  "hint": "<string>"
}

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.

Body

application/json

Report options. Every field is optional; the default is the standard technical PDF with Strix branding.

format

enum<string>

default:technical

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

Available options:

technical,

retest,

attestation,

executive_summary

file_type

enum<string>

default:pdf

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

Available options:

pdf,

docx

provider_name

string

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

Maximum string length: 80

client_name

string

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

Maximum string length: 120

prepared_by

object[]

Up to two team members credited as authors of the assessment (Enterprise branding).

Maximum array length: 2

Show child attributes

Response

Report rendered and stored; the link is ready to download.

export

object

required

Show child attributes

Error

A valid request URL is required to generate request examples

{
  "export": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "scan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "format": "technical",
    "file_type": "pdf",
    "filename": "<string>",
    "content_type": "<string>",
    "size_bytes": 123,
    "url": "<string>",
    "expires_at": "2023-11-07T05:31:56Z"
  }
}

{
  "detail": "<string>",
  "code": "<string>",
  "required_scope": "scans:read",
  "docs": "<string>",
  "hint": "<string>"
}

{
  "detail": "<string>",
  "code": "<string>",
  "required_scope": "scans:read",
  "docs": "<string>",
  "hint": "<string>"
}

{
  "detail": "<string>",
  "code": "<string>",
  "required_scope": "scans:read",
  "docs": "<string>",
  "hint": "<string>"
}

{
  "detail": "<string>",
  "code": "<string>",
  "required_scope": "scans:read",
  "docs": "<string>",
  "hint": "<string>"
}

{
  "detail": "<string>",
  "code": "<string>",
  "required_scope": "scans:read",
  "docs": "<string>",
  "hint": "<string>"
}

Analytics

Asset Discovery

Audit

Billing

Chat

CLI

Connectors

Containers

Assets

Test Users

Integrations

Knowledge

License

LLM

Run Logs

Organization

Invitations

Members

PR Reviews

Vulnerabilities

Supply Chain

Scans

Schedules

Search

Tokens

Uploads

Webhooks

Workspaces

Repositories

Export scan report as a download link

Authorizations

Path Parameters

Body

Response