POST
/
upload
/
request
Request Upload
curl --request POST \
  --url https://app.buildstash.com/api/v1/upload/request \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "structure": "file",
  "platform": "windows",
  "stream": "nightlies",
  "source": "ghactions",
  "primary_file": {
    "filename": "example.exe",
    "size_bytes": 52428800
  },
  "version_component_1_major": 1,
  "version_component_2_minor": 0,
  "version_component_3_patch": 1
}'
{
  "message": "Upload request successful",
  "pending_upload_id": "<string>",
  "primary_file": {
    "filename": "example.exe",
    "chunked_upload": true,
    "chunked_number_parts": 14,
    "chunked_part_size_mb": 52428800,
    "presigned_data": {
      "url": "<string>",
      "headers": {
        "Content-Type": "application/x-msdownload",
        "Content-Length": "734003200",
        "Content-Disposition": "attachment; filename=\"example.exe\""
      }
    }
  },
  "expansion_files": [
    {
      "filename": "expansion.obb",
      "chunked_upload": false,
      "chunked_number_parts": "",
      "chunked_part_size_mb": "",
      "presigned_data": {
        "url": "<string>",
        "headers": {
          "Content-Type": "application/octet-stream",
          "Content-Length": "734003200",
          "Content-Disposition": "attachment; filename=\"expansion.obb\""
        }
      }
    }
  ]
}
This endpoint initiates the build upload process by requesting presigned URLs. The response will indicate whether single-part or multipart upload is possible. Multipart is always required for files larger than 5GB.

Overview

The upload request endpoint is the first step in uploading a new build. It provides all key build information, and returns a presigned URL for direct upload or multipart upload information for larger files.

Authorizations

Authorization
string
header
required

App-specific auth token. Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Upload request details

The body is of type object.

Response

Upload request successful

The response is of type object.