Download File
Download files using issued tokens. Issued tokens are single-use and expire after 30 minutes. You can obtain a token for downloading query results from the Create Query Result Download Token API, a token for downloading a dashboard widget or tab screen as an image from the Create dashboard image download token API, and a token for exporting a real-time or batch detection scenario from the Create Rule Export Token API.
Required Permissions
Requires a valid download token.
HTTP Request
GET /downloader
cURL Example
curl -H "Authorization: Bearer <API_KEY>" \
"https://HOSTNAME/downloader?token=4ba40c97-b31b-450f-8af8-ceb1b94f5514&force_download=true"
Request Parameters
| Key | Required | Type | Description | Notes |
|---|---|---|---|---|
| token | Y | String | Download token GUID | 36-character GUID (e.g., 4ba40c97-b31b-450f-8af8-ceb1b94f5514) |
| force_download | N | Boolean | Force file download | true: direct download, false: attempt browser preview |
Success Response
HTTP status code 200 with file content
Response Headers
| Header | Description |
|---|---|
| Content-Type | MIME type based on file extension |
| Content-Disposition | attachment (direct download) or inline (browser preview) |
| Transfer-Encoding | chunked (chunked transfer encoding) |
The response body contains the binary data of the requested file.
Error Responses
Token missing or invalid
When the token cannot be found, has already been used, or has expired, the server returns HTTP status code 403 and does not send the file content.