Documentation Index

Fetch the complete documentation index at: https://docs.xtremepush.com/llms.txt

Use this file to discover all available pages before exploring further.

Download File by ID

Prev Next
Post
/file/{fileId}/download

Used to retrieve a specific file using its unique file identifier.


Overview

Use this endpoint to download files generated within the Xtremepush platform. This request returns a 302 redirect to a pre-signed S3 URL that expires after 5 minutes.

You can download exported segments or other platform-generated files using this endpoint.

The primary requirement for this request is the fileId path parameter. You must also include standard OAuth 2.0 authentication headers to access the endpoint.


Prerequisites: You must use a valid OAuth 2.0 access token. The File Download scope must be enabled for your API Client ID. The requested file must belong to your authenticated project. If you attempt to access a file from a different project, the request returns a 403 Forbidden error.

Header parameters
Authorization
stringRequired

The OAuth 2.0 bearer token. Example: Bearer

Path parameters
fileId
stringRequired

The unique identifier of the file to download

Responses
302

The request is successful. The response includes a Location header containing the presigned S3 URL. This link is valid for 5 minutes.

401

Unauthorized

Result
{
  "success": "False",
  "message": "oAuth authentication required"
}
object
success
boolean
Defaultfalse
message
string
Default"oAuth authentication required"
403

Forbidden

Result
{
  "name": "Bad Request",
  "message": "Access Denied"
}
object
name
string
Default"Bad Request"
message
string
Default"Access Denied"
404

Not Found

Result
{
  "name": "Not Found",
  "message": "File Not Found"
}
object
name
string
Default"Not Found"
message
string
Default"File Not Found"
500

Internal Server Error

Result
{
  "name": "Internal Server Error",
  "message": "S3 not configured"
}
object
name
string
Default"Internal Server Error"
message
string
Default"S3 not configured"