Nintendo Switch symbol upload

Upload Nintendo Switch symbol files to allow Bugsnag to symbolicate stacktraces.

Overview

You will need to upload the generated symbol file for your Nintendo Switch game to Bugsnag to see the source file, line number and method in error stacktraces.

Uploading mapping files

To send Nintendo Switch symbol mapping files to Bugsnag, POST them to https://upload.bugsnag.com/nintendo-switch-symbol (or the address of your upload server, if using Bugsnag On-premise) with the following parameters:

  • symbolFile - the path to the Nintendo Switch symbol file.
  • apiKey - your Bugsnag integration API key for this application.
  • projectRoot - (optional) the root path of the project on the filesystem where the application was built.
  • overwrite - (optional) whether to overwrite any existing symbol file for the same build, either true or false
  • appVersion - (optional) the version of the application that the symbols relate to.
  • moduleName - (optional) the name of the module/application/binary that the symbols relate to.

cURL example

Here’s an example request with curl, where the ’@’ sign indicates that the symbolFile parameter is an uploaded file:

$ curl --http1.1 \
    "https://upload.bugsnag.com/nintendo-switch-symbol" \
    -F symbolFile=@path/to/example.nss \
    -F apiKey=YOUR_API_KEY_HERE \
    -F appVersion=1.2.3 \
    -F overwrite=true

Response codes

If the file is accepted then an HTTP 202 response will be returned with the body “Accepted”.

If not, there are several possible problems which will be indicated with an HTTP 4XX response:

  • 400 - missing required file - indicates that the file is missing.
  • 400 - missing required param - indicates that a required parameter is missing.
  • 400 - invalid file format - indicates that the uploaded symbols file was in an incorrect format (not ELF)
  • 422 - received empty file - indicates that the uploaded file is empty
  • 401 - invalid apiKey - indicates that the provided apiKey doesn’t correspond to a Bugsnag project.
  • 409 - duplicate symbol file - indicates that Bugsnag already has the provided file. You can ignore this error by using the overwrite parameter.