reports

Get the status of an exported report

Poll this endpoint for the status of a report export you have queued. When complete, you will receive a download URL.

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

get/reports/status

Request

Base URL
https://cyber-risk.upguard.com/api/public
Auth
API key in header Authorization
TypeScript
https://skmtc.dev/upguard/apis/upguard-cyberrisk-api/docs/reports/status/get.ts
A function with typed inputs. Its response is checked against the schema.

queued_report_idstring required

The queued_report_id returned from the /reports/queue endpoint.

Queued report status

download_urlstring

URL to download the completed report. Only included if status is "completed"

download_url_expiresstring

Expiration timestamp for the download URL. Only included if status is "completed"

status'completed' | 'pending' | 'failed' required

Report status

No recorded changes to this operation across all 1 revision of this API.