---
title: "Queue a report export"
method: POST
path: "/reports/queue"
tags: ["reports"]
---

# Queue a report export

`POST /reports/queue`

## Request

- Base URL: `https://cyber-risk.upguard.com/api/public`
- URL: `https://cyber-risk.upguard.com/api/public/reports/queue`
- Auth: API key in header `Authorization`
- TypeScript: <https://skmtc.dev/upguard/apis/upguard-cyberrisk-api/docs/reports/queue/post.ts> (a function with typed inputs; its response is checked against the schema)

Asynchronously queues a report for exporting. To use this API, first call this endpoint with the type of report you wish to
generate and any other filtering parameters. You can optionally specify a list of email addresses or a URL
that will receive a POST request when the export completes.

When a report is queued, you will receive a unique queued_report_id. Use this ID to check the status of the export using the
`/reports/status` endpoint.

Required API key permissions: `Platform` (select when creating API key in Account Settings)

## Query parameters

- `report_type` 'BoardSummaryPDF' | 'BoardSummaryPPTX' | 'BreachSightSummaryPDF' | 'BreachSightDetailedPDF' | 'VendorRiskExecutiveSummaryPDF' | 'VendorSummaryPDF' | 'VendorDetailedPDF' | 'VendorRiskAssessmentPDF' | 'CustomPDF' | 'VendorRiskProfileXLSX' | 'VendorVulnsOverviewXLSX' | 'VendorDomainListPDF' | 'QuestionnaireDetailsPDF' | 'QuestionnaireDetailsXLSX', required
- `custom_report_uuid` string
- `email_addresses` string[]
- `post_webhook_url` string, uri
- `asset_portfolio_names` string[]
- `vendor_portfolio_names` string[]
- `vendor_id` integer
- `vendor_primary_hostname` string
- `filter_by_vendor_hostnames` string
- `filename_prefix` string
- `wait_for_data` boolean
- `questionnaire_id` integer
- `include_messages` boolean
- `include_private_messages` boolean

## Response `200`

Report queued for export

- QueueReportResponsePayloadBody
  - `queued_report_id` string: The ID of the queued report. Use this when polling the /reports/status endpoint for a download URL.

## Other responses

- `403`: Your API key does not have permission to perform this action.
- `422`: An invalid parameter was supplied or a mandatory parameter was missing
- `429`: Too many requests have been made to this endpoint.
- `500`: An internal system error occurred

## Changes

- **2026-11-07** `d044bf6dc61e`: 3 info
  - added the new optional `query` request parameter `include_messages`
  - added the new optional `query` request parameter `include_private_messages`
  - added the new optional `query` request parameter `questionnaire_id`

[Operation history](https://skmtc.dev/upguard/apis/upguard-cyberrisk-api/changes/reports/queue/post.md)

---

[API](https://skmtc.dev/upguard/apis/upguard-cyberrisk-api.md) - [All operations](https://skmtc.dev/upguard/apis/upguard-cyberrisk-api/llms.txt) - [OpenAPI document](https://skmtc.dev/upguard/apis/upguard-cyberrisk-api/revisions/d044bf6dc61e?raw)