Skip to content

Latest commit

 

History

History
269 lines (236 loc) · 12.9 KB

versions.md

File metadata and controls

269 lines (236 loc) · 12.9 KB
description
API Documentation for the BugSplat Versions Endpoint

Versions

{% hint style="info" %} This endpoint supports paging, and filtering queries. More information on paging, filtering, and grouping is available here. {% endhint %}

Get a list stats for crashes that have been posted separated by application and version, create a new version, or set the retired and full dumps flags on a specified version.

Versions

GET https://app.bugsplat.com/api/versions

Returns a list of versions in a given database.

Query Parameters

Name Type Description
database string BugSplat database containing symbol stores

{% tabs %} {% tab title="200 " %}

[
    {
        "Database": "Fred",
        "PageData": null,
        "Rows": [
            {
                "symbolId": "163434",
                "appName": "myConsoleCrasher",
                "version": "2022.4.20.0",
                "size": "14.6255",
                "lastUpdate": "2022-04-20T14:20:14Z",
                "lastReport": "2022-04-20T14:20:14Z",
                "firstReport": "2022-04-20T02:06:31Z",
                "reportsPerDay": null,
                "fullDumps": "0",
                "rejectedCount": "0",
                "retired": "0"
            },
            {
                "symbolId": "163348",
                "appName": "myConsoleCrasher",
                "version": "2022.4.19.0",
                "size": "37.3619",
                "lastUpdate": "2022-04-19T19:55:42Z",
                "lastReport": "2022-04-19T19:55:42Z",
                "firstReport": "2022-04-19T00:52:34Z",
                "reportsPerDay": null,
                "fullDumps": "0",
                "rejectedCount": "0",
                "retired": "0"
            },
            {
                "symbolId": "163338",
                "appName": "myDotNetCrasher",
                "version": "2022.4.19.0",
                "size": "4.1651",
                "lastUpdate": "2022-04-19T18:03:25Z",
                "lastReport": "2022-04-19T18:03:25Z",
                "firstReport": "2022-04-19T00:03:49Z",
                "reportsPerDay": null,
                "fullDumps": "0",
                "rejectedCount": "0",
                "retired": "0"
            },
            {
                "symbolId": "163242",
                "appName": "myConsoleCrasher",
                "version": "2022.4.18.0",
                "size": "49.7142",
                "lastUpdate": "2022-04-18T19:55:30Z",
                "lastReport": "2022-04-18T19:55:30Z",
                "firstReport": "2022-04-18T00:55:05Z",
                "reportsPerDay": null,
                "fullDumps": "0",
                "rejectedCount": "0",
                "retired": "0"
            },
            {
                "symbolId": "163232",
                "appName": "myDotNetCrasher",
                "version": "2022.4.18.0",
                "size": "4.2373",
                "lastUpdate": "2022-04-18T18:03:24Z",
                "lastReport": "2022-04-18T18:03:24Z",
                "firstReport": "2022-04-18T00:02:59Z",
                "reportsPerDay": null,
                "fullDumps": "0",
                "rejectedCount": "0",
                "retired": "0"
            },
            {
                "symbolId": "163162",
                "appName": "myConsoleCrasher",
                "version": "2022.4.17.0",
                "size": "37.3619",
                "lastUpdate": "2022-04-17T19:52:27Z",
                "lastReport": "2022-04-17T19:52:27Z",
                "firstReport": "2022-04-17T00:51:10Z",
                "reportsPerDay": null,
                "fullDumps": "0",
                "rejectedCount": "0",
                "retired": "0"
            },
            {
                "symbolId": "163152",
                "appName": "myDotNetCrasher",
                "version": "2022.4.17.0",
                "size": "4.2329",
                "lastUpdate": "2022-04-17T18:03:28Z",
                "lastReport": "2022-04-17T18:03:28Z",
                "firstReport": "2022-04-17T00:03:07Z",
                "reportsPerDay": null,
                "fullDumps": "0",
                "rejectedCount": "0",
                "retired": "0"
            },
            {
                "symbolId": "163062",
                "appName": "myConsoleCrasher",
                "version": "2022.4.16.0",
                "size": "48.5396",
                "lastUpdate": "2022-04-16T19:57:59Z",
                "lastReport": "2022-04-16T19:57:59Z",
                "firstReport": "2022-04-16T00:52:51Z",
                "reportsPerDay": null,
                "fullDumps": "0",
                "rejectedCount": "0",
                "retired": "0"
            },
            {
                "symbolId": "163052",
                "appName": "myDotNetCrasher",
                "version": "2022.4.16.0",
                "size": "4.3028",
                "lastUpdate": "2022-04-16T18:02:53Z",
                "lastReport": "2022-04-16T18:02:53Z",
                "firstReport": "2022-04-16T00:03:40Z",
                "reportsPerDay": null,
                "fullDumps": "0",
                "rejectedCount": "0",
                "retired": "0"
            },
            {
                "symbolId": "163020",
                "appName": "myConsoleCrasher",
                "version": "2022.4.15.0",
                "size": "25.6763",
                "lastUpdate": "2022-04-15T19:51:33Z",
                "lastReport": "2022-04-15T19:51:33Z",
                "firstReport": "2022-04-15T16:29:47Z",
                "reportsPerDay": null,
                "fullDumps": "0",
                "rejectedCount": "0",
                "retired": "0"
            }
        ]
    }
]

{% endtab %} {% endtabs %}

Curl Example

curl --location 'https://app.bugsplat.com/api/versions?database=fred' \
--header 'Authorization: Bearer ••••••'

Versions

POST https://app.bugsplat.com/api/versions

Used to create a new version and returns a pre-signed URL that can be used to upload new symbol files.

Request Body

Name Type Description
database string BugSplat database in which the symbol store should be created
appVersion* string Version of the application symbols being stored in the new symbol store
appName* string Name of application symbols being stored in the new symbol store
symFileName string Filename of the symbol file being uploaded to the symbol store via the returned pre-signed URL.
size number Size of symbol file being uploaded to the symbol store via the returned pre-signed URL. Enter 0 to create a placeholder symbol store

{% tabs %} {% tab title="200 " %}

{
    "Status": "Success",
    "url": "",
    "database": "Fred",
    "appName": "test",
    "appVersion": "1.0"
}

{% endtab %} {% endtabs %}

Curl Example

curl --location 'https://app.bugsplat.com/api/versions' \
--header 'Authorization: Bearer ••••••' \
--form 'database="fred"' \
--form 'appName="Postman"' \
--form 'appVersion="1.2.3"' \
--form 'size="0"' \
--form 'symFileName="test.pdb"'

Versions

PUT https://app.bugsplat.com/api/versions

Used to set the retired and fullDumps flags for a specified version.

Request Body

Name Type Description
database string BugSplat database in which the symbol store should be created
appVersion* string Version of application for which the retired/fullDumps flags should be updated
appName* string Name of application for which the retired/fullDumps flags should be updated
fullDumps 0|1

Flag indicating that the BugSplat Native and .NET SDKs should generate and upload

full memory dumps

. This feature incurs additional costs.

Contact us

to enable full memory dumps for your account.
retired 0|1 Flag indicating that the version should be marked as retired. Crash reports for retired versions will not be ingested or processed.

{% tabs %} {% tab title="200 " %}

{
    "Status": "Success",
    "database": "Fred",
    "symbolId": 163434,
    "retired": 1
}

{% endtab %} {% endtabs %}

Versions

DELETE https://app.bugsplat.com/api/versions

Remove symbols from a specified version or versions.

Path Parameters

Name Type Description
database* string BugSplat database containing versions with symbols for removal
appName string Single application name to remove symbols for, required if appVersion is set
appVersion string Single application version to remove symbols for, required if appName is set
appVersions array Multi-dimensional array of appName and appVersion for symbol removal eg app0,version0,app1,version1. Required if appName and appVersion are not set.

Curl Example

curl --location --request DELETE 'https://app.bugsplat.com/api/versions?database=fred&appName=Postman&appVersion=1.2.3' \
--header 'Authorization: Bearer ••••••'