Upload Debug Symbols

Upload debug symbol files (.pdb) to enhance the accuracy of security analysis. Debug symbols provide additional context that helps identify more vulnerabilities.

When to Use This Endpoint

Upload debug symbols after uploading your binary image when:

You have .pdb files available from your build process
You want more accurate vulnerability detection
You need better source code correlation in findings

Tip: Debug symbols significantly improve analysis accuracy. Always upload them when available.

Request

Endpoint

POST <BINARLY_API_URL>/api/v4/products/{productId}/images/{imageId}/files

Path Parameters

Parameter	Description
`productId`	The product ID (e.g., `01JQPGDX8QW0YJ0XEKV1EVG534`)
`imageId`	The image ID from the upload response (e.g., `01JYJ0W0AACGC7QT1Q21SRWG94`)

Headers

Header	Value
`Authorization`	`Bearer <access_token>`
`Content-Type`	`multipart/form-data`

Form Fields

Field	Required	Description
`file`	Yes	The debug symbol file (.pdb)

Example Request - Single File

# Set your variables
BINARLY_PRODUCT_ID="01JQPGDX8QW0YJ0XEKV1EVG534"
IMAGE_ID="01JYJ0W0AACGC7QT1Q21SRWG94"
PDB_FILE="/path/to/firmware.pdb"

# Upload the debug symbol file
curl -X POST \
  -H "Authorization: Bearer ${TOKEN}" \
  -F "file=@${PDB_FILE}" \
  "${BINARLY_API_URL}/api/v4/products/${BINARLY_PRODUCT_ID}/images/${IMAGE_ID}/files"

Example Request - Batch Upload

If you have multiple .pdb files, upload them in a loop:

# Set your variables
BINARLY_PRODUCT_ID="01JQPGDX8QW0YJ0XEKV1EVG534"
IMAGE_ID="01JYJ0W0AACGC7QT1Q21SRWG94"
SYMBOLS_DIR="/path/to/symbols"

# Find and upload all .pdb files
find "$SYMBOLS_DIR" -name "*.pdb" | while IFS= read -r PDB_FILE; do
  echo "Uploading: $PDB_FILE"
  
  RESPONSE=$(curl -s -X POST \
    -H "Authorization: Bearer ${TOKEN}" \
    -F "file=@${PDB_FILE}" \
    "${BINARLY_API_URL}/api/v4/products/${BINARLY_PRODUCT_ID}/images/${IMAGE_ID}/files")
  
  # Check if upload succeeded
  if echo "$RESPONSE" | jq -e '.id' > /dev/null 2>&1; then
    echo "Uploaded successfully"
  else
    echo "Upload failed: $RESPONSE"
  fi
done

Response

The endpoint returns 201 Created with the new file.

{
  "id": "01K6Z3V9Q2M7XH4D8RTN5B1C0E",
  "filename": "firmware.pdb",
  "createTime": "2026-01-28T12:00:00Z",
  "isAttachment": true,
  "downloadUrl": "https://storage.googleapis.com/...",
  "metadata": {
    "pdb_guid": "e9e59827-6c4f-4b2a-9b1e-2f3d4c5b6a70"
  },
  "author": {
    "id": "01JV49FS1ZSGQ72NN6E0RXK3T0",
    "userId": "01JV49FS1ZSGQ72NN6E0RXK3T0",
    "email": "user@example.com",
    "status": "active"
  }
}

Field	Description
`id`	Unique file identifier (ULID format)
`filename`	The uploaded file name
`createTime`	Timestamp when file was uploaded
`isAttachment`	`true` for files attached to an image, such as symbols
`downloadUrl`	Pre-signed URL to download the file
`metadata`	File details, for example `pdb_guid` for PDB files
`author.email`	Email of the user or API client that uploaded the file

A request without the file field returns 400 with {"details":[{"field":"file","reason":"Field value required"}],"message":"File field required"}.

Best Practices

Practice	Description
Upload after firmware	Always upload debug symbols after the firmware image
Include all symbols	Upload all available .pdb files from your build
Automate in CI/CD	Integrate symbol upload into your build pipeline
Keep symbols secure	Debug symbols contain sensitive information - transfer via HTTPS only

User Guides

Debugging Symbols Guide - UI walkthrough for uploading and verifying PDB files

Overview

Use Cases

Reference

When to Use This Endpoint

Request

Example Request - Single File

Example Request - Batch Upload

Response

Best Practices

When to Use This Endpoint

Request

Example Request - Single File

Example Request - Batch Upload

Response

Best Practices

Related