Access information about your organization, projects, errors, and more to build custom integrations.
All requests to the Bugsnag API require authentication. To authenticate API requests you can either use your Bugsnag user credentials, or your account-wide auth token.
To access the Bugsnag API as a user, you can use your Bugsnag user credentials via Basic Authentication. Simply send the email address and password associated with the user:
curl -u email@example.com:password https://api.bugsnag.com
Alternatively you can authenticate by using Personal Auth Tokens, which you can generate in the My Account section of Bugsnag settings.
There are two ways to send this auth token with requests, you can send the token
$ curl -H "Authorization: token YOUR-TOKEN-HERE" https://api.bugsnag.com
or, you can authenticate using a parameter:
$ curl https://api.bugsnag.com/?auth_token=YOUR-AUTH-TOKEN-HERE
You can authenticate as an Organization using your organization’s Data access API key, which you can find in the Organization section of your Bugsnag settings.
Organization API access keys are used the same way as Personal Auth tokens, but they map to the organization as a whole rather than a specific user.
Many API methods take optional parameters. For GET requests, any parameters not specified as a segment in the path can be passed as an HTTP query string parameter.
For POST, PATCH, and DELETE requests, parameters not included in the URL should be encoded as JSON with a Content-Type of ‘application/json’.
400 Bad Requestresponse
400 Bad Requestresponse
404 Not Foundresponse
404 Not Foundresponse, in order to avoid disclosing the existence of user data
All API resources may have one or more
*_url properties linking to other
resources. These are meant to provide explicit URLs so that API clients don’t
need to construct URLs on their own. It is highly recommended that API clients
use these. Doing so will make future upgrades of the API easier for developers.
Pagination info is included in the Link header. It is important to follow these Link header values instead of constructing your own URLs since the pagination method can differ between resources.
The URL for pagination is shown inside angled brackets, and the type of
pagination link is described in the
Link: <https://api.bugsnag.com/account/projects?offset=51f42cc7b2db42c554000086>; rel="next"
The possible values for
next- Shows the URL for the next page of results
prev- Shows the URL for the previous page of results