bugsnag.api.* operation is listed below with parameter shapes and return types from the plugin Zod schemas.
Collaborators
delete
collaborators.delete
Remove a collaborator, revoking access to every project in the organization
Risk: destructive
get
collaborators.get
Get a single collaborator
Risk: read
project_roles full type
project_roles full type
getOnProject
collaborators.getOnProject
Get a collaborator in the context of a project
Risk: read
project_roles full type
project_roles full type
getProjectAccess
collaborators.getProjectAccess
Get how one collaborator reaches one project
Risk: read
project_summary full type
project_summary full type
invite
collaborators.invite
Invite a collaborator to an organization by email address
Risk: write
project_roles full type
project_roles full type
list
collaborators.list
List the collaborators on an organization
Risk: read
object[]
Output full type
Output full type
listOnProject
collaborators.listOnProject
List the collaborators who can reach a project
Risk: read
object[]
Output full type
Output full type
listProjectAccesses
collaborators.listProjectAccesses
List how a collaborator reaches each project, with the granting role
Risk: read
object[]
Output full type
Output full type
listProjects
collaborators.listProjects
List the projects a collaborator can reach
Risk: read
object[]
Output full type
Output full type
projectAccessCounts
collaborators.projectAccessCounts
Count how many projects each named collaborator can reach
Risk: read
object[]
Output full type
Output full type
updatePermissions
collaborators.updatePermissions
Change a collaborator’s project access or admin status
Risk: write
project_roles full type
project_roles full type
project_roles full type
project_roles full type
Data Deletions
confirmForProject
dataDeletions.confirmForProject
Confirm a project event data deletion, irreversibly erasing the matched data
Risk: destructive
createForOrganization
dataDeletions.createForOrganization
Create a request to erase matching event data across an organization
Risk: destructive
filters full type
filters full type
createForProject
dataDeletions.createForProject
Create a request to erase matching event data in a project
Risk: destructive
filters full type
filters full type
getForOrganization
dataDeletions.getForOrganization
Check the status of an organization event data deletion
Risk: read
getForProject
dataDeletions.getForProject
Check the status of a project event data deletion
Risk: read
Data Requests
createForOrganization
dataRequests.createForOrganization
Request an export of an organization’s event data for a subject access request
Risk: write
filters full type
filters full type
createForProject
dataRequests.createForProject
Request an export of a project’s event data for a subject access request
Risk: write
filters full type
filters full type
getForOrganization
dataRequests.getForOrganization
Check the status of an organization event data export
Risk: read
getForProject
dataRequests.getForProject
Check the status of a project event data export
Risk: read
Errors
bulkUpdate
errors.bulkUpdate
Apply one operation to many errors at once, including delete and discard
Risk: destructive
reopen_rules full type
reopen_rules full type
deleteAll
errors.deleteAll
Permanently delete every error and event in a project
Risk: destructive
list
errors.list
List the error groups on a project
Risk: read
filters full type
filters full type
object[]
Output full type
Output full type
Event Fields
create
eventFields.create
Create a custom event field from a path inside event metadata
Risk: write
filter_options full type
filter_options full type
delete
eventFields.delete
Delete a custom event field
Risk: destructive
list
eventFields.list
List the fields a project can filter and pivot on
Risk: read
object[]
Output full type
Output full type
Events
list
events.list
List the individual event occurrences on a project
Risk: read
filters full type
filters full type
object[]
Output full type
Output full type
listForError
events.listForError
List the individual events belonging to one error
Risk: read
filters full type
filters full type
object[]
Output full type
Output full type
Feature Flags
list
featureFlags.list
List the feature flags seen on a project in a release stage
Risk: read
object[]
Output full type
Output full type
listSummaries
featureFlags.listSummaries
List feature flag summaries for a project
Risk: read
object[]
Output full type
Output full type
Integrations
configure
integrations.configure
Configure an integration on a project
Risk: write
configuration full type
configuration full type
deleteConfigured
integrations.deleteConfigured
Delete a configured integration
Risk: destructive
getConfigured
integrations.getConfigured
Get a single configured integration
Risk: read
listConfigured
integrations.listConfigured
List the integrations configured on a project
Risk: read
object[]
Output full type
Output full type
listSupported
integrations.listSupported
List every integration BugSnag supports
Risk: read
object[]
Output full type
Output full type
test
integrations.test
Test an integration configuration before creating it
Risk: read
configuration full type
configuration full type
Organizations
delete
organizations.delete
Delete an organization with all of its projects, errors and collaborator access
Risk: destructive
get
organizations.get
Get a single organization
Risk: read
creator full type
creator full type
list
organizations.list
List the organizations the token’s owner belongs to
Risk: read
object[]
Output full type
Output full type
Pivots
list
pivots.list
List the pivot definitions available on a project
Risk: read
filters full type
filters full type
object[]
Output full type
Output full type
values
pivots.values
List one pivot’s values with each value’s share of events
Risk: read
filters full type
filters full type
object[]
Output full type
Output full type
Projects
create
projects.create
Create a project in an organization
Risk: write
target_stability full type
target_stability full type
critical_stability full type
critical_stability full type
delete
projects.delete
Delete a project and its entire error history
Risk: destructive
get
projects.get
Get a single project
Risk: read
target_stability full type
target_stability full type
critical_stability full type
critical_stability full type
list
projects.list
List the projects in an organization
Risk: read
object[]
Output full type
Output full type
networkGroupingRuleset
projects.networkGroupingRuleset
Get a project’s network span grouping ruleset
Risk: read
regenerateApiKey
projects.regenerateApiKey
Rotate a project’s notifier API key, stopping every deployed notifier until redeployed
Risk: destructive
target_stability full type
target_stability full type
critical_stability full type
critical_stability full type
Releases
list
releases.list
List the releases of a project
Risk: read
object[]
Output full type
Output full type
listGroups
releases.listGroups
List the release groups of a project within a release stage
Risk: read
object[]
Output full type
Output full type
Saved Searches
create
savedSearches.create
Create a saved search from a filter configuration
Risk: write
filters full type
filters full type
delete
savedSearches.delete
Delete a saved search
Risk: destructive
get
savedSearches.get
Get a single saved search
Risk: read
list
savedSearches.list
List the saved searches on a project
Risk: read
object[]
Output full type
Output full type
usageSummary
savedSearches.usageSummary
Report what depends on a saved search, to check before deleting it
Risk: read
Teams
addCollaboratorMemberships
teams.addCollaboratorMemberships
Add a collaborator to teams, or to all of them
Risk: write
project_roles full type
project_roles full type
addMembers
teams.addMembers
Add collaborators to a team, or add all of them
Risk: write
create
teams.create
Create a team in an organization
Risk: write
delete
teams.delete
Delete a team, removing the grouping but not its members
Risk: destructive
get
teams.get
Get a single team
Risk: read
list
teams.list
List the teams in an organization
Risk: read
object[]
Output full type
Output full type
Trends
projectBuckets
trends.projectBuckets
Get a project’s event counts split into time buckets
Risk: read
filters full type
filters full type
object[]
Output full type
Output full type