Crash Post Endpoints

The following documentation describes how customers can POST crashes directly to BugSplat via a suite of endpoints specific to their BugSplat database. It is important that all these crashes are uploaded via your BugSplat subdomain to ensure that they are not rejected by our backend.

Xbox

POST https://{{database}}.bugsplat.com/post/xbox/crash

Uploads an Xbox crash report and optional metadata

Path Parameters

Name	Type	Description
{{database}}*	string	Replace the subdomain value with the value of your BugSplat database

Request Body

Name	Type	Description
minidump*	object	The minidump file to be uploaded
appName*	string	Name of the crashing application. IMPORTANT this value must match the value used to upload symbols.
appVersion*	string	Crashing application's version. IMPORTANT this value must match the value used to upload symbols
appKey	string	Optional application identifier that provides extra data for searching and grouping
description	string	Optional description of why the crash occurred
email	string	Optional email address for the user that crashed
ipAddress	string	Optional IP address of the crashing user
user	string	Optional username for the user that crashed

200

{
    "status": "success",
    "crashId": 1,
    "techSupportUrl": "https://app.bugsplat.com/browse/crashInfo.php?vendor=fred&version=1.0&key=key&id=99999999&row=1"
}

PlayStation 4

POST https://{{database}}.bugsplat.com/post/ps4/crash

Uploads a Playstation 4 crash report, extracts user data and user files

Path Parameters

Name	Type	Description
{{database}}*	string	Replace the subdomain value with the value of your BugSplat database

Request Body

Name	Type	Description
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

200

{
    "status": "success",
    "crashId": 1,
    "techSupportUrl": "https://app.bugsplat.com/browse/crashInfo.php?vendor=fred&version=1.0&key=key&id=99999999&row=1"
}

PlayStation 5

POST https://{{database}}.bugsplat.com/post/ps5/crash

Uploads a Playstation 5 crash report, extracts user data and user files

Path Parameters

Name	Type	Description
{{database}}*	string	Replace the subdomain value with the value of your BugSplat database

Request Body

Name	Type	Description
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

200

{
    "status": "success",
    "crashId": 1,
    "techSupportUrl": "https://app.bugsplat.com/browse/crashInfo.php?vendor=fred&version=1.0&key=key&id=99999999&row=1"
}

Crashpad

POST {{database}}.bugsplat.com/post/bp/crash/crashpad.php

Uploads a Crashpad crash report with optional metadata.

Path Parameters

Name	Type	Description
{{database}}*	String	Replace the subdomain value with the name of your BugSplat database

Request Body

Name	Type	Description
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

200: OK

{
    "status": "success",
    "crash_id": 1,
    "url": "https://app.bugsplat.com/browse/crashInfo.php?vendor=fred&version=1.0&key=key&id=99999999&row=1"
}

Example

The following is an example that uses curl to demonstrate posting a crash to BugSplat. Be sure to update the value of {{database}} with the value of your BugSplat database.

curl --request POST 'https://{{database}}.bugsplat.com/post/xbox/crash' \
--form 'appName="my-xbox-crasher"' \
--form 'appVersion="1.0.0"' \
--form 'minidump=@"/path/to/minidump.dmp"'

XML

POST {{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

Name	Type	Description
{{database}}*	String	Replace the subdomain value with the name of your BugSplat database

Request Body

Name	Type	Description
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
email	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

200: OK

{
    "status": "success",
    "crash_id": 1,
    "url": "https://app.bugsplat.com/browse/crashInfo.php?vendor=fred&version=1.0&key=key&id=99999999&row=1"
}

Example XML File

<report>
    <process>
        <exception>
            <code>FATAL ERROR</code>
            <explanation>This is an error code explanation</explanation>
            <func><![CDATA[myConsoleCrasher!MemoryException]]></func>
            <file>/www/bugsplatAutomation/myConsoleCrasher/myConsoleCrasher.cpp</file>
            <line>143</line>
            <registers>
                <cs>0023</cs>
                <ds>002b</ds>
                <eax>00000011</eax>
                <ebp>00affb58</ebp>
                <ebx>00858000</ebx>
                <ecx>43bf1e0e</ecx>
                <edi>00affb58</edi>
                <edx>014480b4</edx>
                <efl>00010202</efl>
            </registers>
        </exception>
        <modules numloaded="2">
            <module>
                <name>myConsoleCrasher</name>
                <order>1</order>
                <address>01320000-01457000</address>
                <path>C:/www/BugsplatAutomation/BugsplatAutomation/bin/x64/Release/temp/BugSplat/bin/myConsoleCrasher.exe</path>
                <symbolsloaded>deferred</symbolsloaded>
                <fileversion/>
                <productversion/>
                <checksum>00000000</checksum>
                <timedatestamp>SatJun1501:18:092019</timedatestamp>
            </module>
            <module>
                <name>BugSplatRc</name>
                <order>2</order>
                <address>01320000-01457000</address>
                <path>C:/www/BugsplatAutomation/BugsplatAutomation/bin/x64/Release/BugSplatRc.dll</path>
                <symbolsloaded>deferred</symbolsloaded>
                <fileversion/>
                <productversion/>
                <checksum>00000000</checksum>
                <timedatestamp>SatJun1501:18:092019</timedatestamp>
            </module>
        </modules>
        <threads count="2">
            <thread id="0" current="yes" event="yes" framecount="3">
                <frame>
                    <symbol><![CDATA[myConsoleCrasher!MemoryException]]></symbol>
                    <file>/www/bugsplatAutomation/myConsoleCrasher/myConsoleCrasher.cpp</file>
                    <line>143</line>
                    <offset>0x35</offset>
                </frame>
                <frame>
                    <symbol>
                        <![CDATA[myConsoleCrasher!wmain]]>
                    </symbol>
                    <file>C:/www/BugsplatAutomation/BugsplatAutomation/BugSplat/samples/myConsoleCrasher/myConsoleCrasher.cpp</file>
                    <line>83</line>
                    <offset>0x239</offset>
                </frame>
                <frame>
                    <symbol><![CDATA[myConsoleCrasher!__scrt_wide_environment_policy::initialize_environment]]></symbol>
                    <file>d:/agent/_work/4/s/src/vctools/crt/vcstartup/src/startup/exe_common.inl</file>
                    <line>90</line>
                    <offset>0x43</offset>
                </frame>
            </thread>
            <thread id="1" current="no" event="no" framecount="3">
                <frame>
                    <symbol><![CDATA[my2ConsoleCrasher!MemoryException]]></symbol>
                    <file>/www/bugsplatAutomation/myConsoleCrasher/myConsoleCrasher.cpp</file>
                    <line>143</line>
                    <offset>0x35</offset>
                </frame>
                <frame>
                    <symbol><![CDATA[my2ConsoleCrasher!wmain]]></symbol>
                    <file>C:/www/BugsplatAutomation/BugsplatAutomation/BugSplat/samples/myConsoleCrasher/myConsoleCrasher.cpp</file>
                    <line>83</line>
                    <offset>0x239</offset>
                </frame>
                <frame>
                    <symbol><![CDATA[my2ConsoleCrasher!__scrt_wide_environment_policy::initialize_environment]]></symbol>
                    <file>d:/agent/_work/4/s/src/vctools/crt/vcstartup/src/startup/exe_common.inl</file>
                    <line>90</line>
                    <offset>0x43</offset>
                </frame>
            </thread>
        </threads>
    </process>
</report>