Crash Post Endpoints
Presigned URL Upload (Recommended)
The recommended method for uploading crash reports to BugSplat is via presigned URLs. This approach is more efficient and scalable than direct POST uploads. The process involves three steps:
Request a presigned upload URL from BugSplat
Upload your zipped crash file and attachments directly to the presigned URL
Commit the upload to finalize processing
For a complete working example, see the python-crash-upload repository.
Before uploading, zip your crash file (e.g., minidump) and all attachments to reduce transfer size.
Step 1: Get Presigned Upload URL
GET https://{{database}}.bugsplat.com/api/getCrashUploadUrl
Requests a presigned URL for uploading a zip file to BugSplat's storage.
Path Parameters
{{database}}*
string
Replace the subdomain value with the value of your BugSplat database
Query Parameters
appName*
string
Name of the crashing application
appVersion*
string
Version of the crashing application
crashPostSize*
number
Size of the zipped crash file in bytes
fullDumpFlag
number
Set to 1 for full memory dumps (bypasses size limit check). Default: 0
internalIP
string
Internal IP address of the crashing machine
Step 2: Upload to Presigned URL
PUT {{presigned_url}}
Upload the zipped crash and attachments directly to the presigned URL returned from Step 1.
Headers
Content-Type*
string
Must be application/octet-stream
Content-Length*
string
Size of the zipped crash file in bytes
Request Body
The raw binary content of your zipped crash file.
Empty response body indicates successful upload.
Step 3: Commit the Upload
POST https://{{database}}.bugsplat.com/api/commitS3CrashUpload
Commits the uploaded crash file for processing by BugSplat.
Path Parameters
{{database}}*
string
Replace the subdomain value with the value of your BugSplat database
Request Body (multipart/form-data)
appName*
string
Name of the crashing application
appVersion*
string
Version of the crashing application
s3Key*
string
The presigned URL returned from Step 1 (used as the S3 key reference)
crashType
string
Type of crash (see Crash Type Reference below). Default: "Windows.Native"
crashTypeId
number
Numeric identifier for the crash type (alternative to crashType string)
fullDumpFlag
number
Set to 1 for full memory dumps. Default: 0
appKey
string
Application key for additional identification
description
string
User-provided crash description
user
string
Username or identifier of the user who experienced the crash
string
Email address of the user who experienced the crash
internalIP
string
Internal IP address of the crashing machine
notes
string
Additional notes about the crash
processor
string
Processor/server identifier for crash processing
crashTime
string
Timestamp of when the crash occurred (ISO format). Default: current time
attributes
string
JSON string of custom attributes to associate with the crash
crashHash
string
Hash of the crash for deduplication purposes
Crash Type Reference
Use the following crashType and crashTypeId values when committing uploads:
Windows
Windows.Native
1
Native Windows minidumps (x86/x64)
.NET
DotNet
2
Legacy .NET crash reports
.NET
DotNetDmp
8
.NET minidumps
.NET Standard
DotNetStandard
18
.NET Core, UWP, and .NET Standard
macOS
PLCrashReporter
13
PLCrashReporter format
Crashpad/Breakpad
Crashpad
6
Cross-platform Crashpad/Breakpad minidumps
Java
Java
4
Java crash reports
JavaScript
JavaScript
14
Browser JavaScript errors
Angular
Angular
19
Angular framework errors
Node.js
NodeJs
20
Node.js crash reports
Electron
Electron
22
Electron application crashes
Python
Python
23
Python crash reports
Unity (Managed)
Unity
12
Unity managed/C# crash reports
Unity (Native)
UnityNative
15
Unity native crash dumps
Unreal Engine
UE4Native
17
UE4/UE5 Windows crash reports
Unreal Engine (Linux)
UE4LinuxServer
16
UE4/UE5 Linux server crash reports
Unreal Engine (Mac)
UE4Mac
33
UE4/UE5 macOS crash reports
iOS
iOS
26
iOS crash reports
PlayStation 4
PlayStation4
28
PS4 crash reports
PlayStation 5
PlayStation5
29
PS5 crash reports
Xbox
Xbox
27
Xbox crash reports
Nintendo
Nintendo
35
Nintendo Switch crash reports
XML
XmlReport
21
Custom XML-formatted crash reports
Direct POST Endpoints
Most crash uploads to BugSplat are done via pre-signed URLs as described above. However, some platforms do not support uploading via pre-signed URLs. The following documentation describes how customers can POST crashes directly to BugSplat via a suite of endpoints specific to their BugSplat database.
All these crashes must be uploaded via your BugSplat subdomain (e.g., https://your-database.bugsplat.com) to ensure that our backend accepts them.
PlayStation 4
POST https://{{database}}.bugsplat.com/post/ps4/crash
Uploads a Playstation 4 crash report, extracts user data and user files
Path Parameters
{{database}}*
string
Replace the subdomain value with the value of your BugSplat database
Request Body
corefile*
object
The core dump file to be uploaded
application*
string
Name of the crashing application.
IMPORTANT
this value must match the value used to upload symbols.
version*
string
Crashing application's version.
IMPORTANT
this value must match the value used to upload symbols
PlayStation 5
POST https://{{database}}.bugsplat.com/post/ps5/crash
Uploads a Playstation 5 crash report, extracts user data and user files
Path Parameters
{{database}}*
string
Replace the subdomain value with the value of your BugSplat database
Request Body
corefile*
object
The core dump file to be uploaded
application*
string
Name of the crashing application.
IMPORTANT
this value must match the value used to upload symbols.
version*
string
Crashing application's version.
IMPORTANT
this value must match the value used to upload symbols
Crashpad
POST https://{{database}}.bugsplat.com/post/bp/crash/crashpad.php
Uploads a Crashpad crash report with optional metadata.
Path Parameters
{{database}}*
String
Replace the subdomain value with the name of your BugSplat database
Request Body
upload_file_minidump*
FILE
File POST parameter. This file can optionally be zip compressed.
other files
FILE
Any additional file POSTs will be attached to the crash report.
product*
String
Application name
version*
String
Application version
key
String
BugSplat crash key
user
String
User reporting the crash
list_annotations
String
User description of the problem
String
XML
POST https://{{database}}.bugsplat.com/post/xml/index.php
Uploads an XML crash report and can be used to create reports for languages and platforms not directly supported by BugSplat.
Path Parameters
{{database}}*
String
Replace the subdomain value with the name of your BugSplat database
Request Body
file*
FILE
XML file containing crash report. File name must be bsCrashReport.xml
other files
FILE
Any additional file POSTs will be attached to the crash report.
appName*
String
Application name
appVersion*
String
Application version
appKey
String
BugSplat crash key
user
String
User reporting the crash
String
Email of user
description
String
User description of the problem
ipAddress
String
IP Address of machine generating report
notes
string
Arbitrary additional data about the crash report
Example XML File
Last updated
Was this helpful?
