Tools
Sentry
Integrate Sentry to manage your error tracking and monitoring.
Create external user for organization
Create external user for organization
Link a user from an external provider to a sentry user.
Delete dsyms for project
Delete dsyms for project
Delete a debug information file for a given project.
Create project key with optional rate limiting
Create project key with optional rate limiting
Create a new client key bound to a project. the key’s secret and public key are generated by the server.
Create organization team
Create organization team
Create a new team bound to an organization. requires at least one of the
name or slug body params to be set.Create dashboard with widgets
Create dashboard with widgets
Create a new dashboard for the given organization
Delete organization dashboard
Delete organization dashboard
Delete an organization’s custom dashboard, or tombstone a pre-built dashboard which effectively deletes it.
Create organization alert rule
Create organization alert rule
Create a new metric alert rule for the given organization. a metric alert rule defines conditions for triggering alerts based on metrics like error count, latency, or failure rate. it specifies the metric type, function, time interval, and thresholds that determine when to trigger alerts. this helps proactively identify and address issues in your project.
Create organization monitor
Create organization monitor
Create a new monitor.
Access project information
Access project information
Return details on an individual project.
Create user for saml integration
Create user for saml integration
Create a new organization member via a scim users post request. note that this api does not support setting secondary emails.
Delete organization release
Delete organization release
Permanently remove a release and all of its files.
Create project rule for alerts
Create project rule for alerts
Create a new issue alert rule for the given project. an issue alert rule triggers whenever a new event is received for any issue in a project that matches the specified alert conditions. these conditions can include a resolved issue re-appearing or an issue affecting many users. alert conditions have three parts: - triggers: specify what type of activity you’d like monitored or when an alert should be triggered. - filters: help control noise by triggering an alert only if the issue matches the specified criteria. - actions: specify what should happen when the trigger conditions are met and the filters match.
Delete organization discover query
Delete organization discover query
Delete a saved query.
Delete external issue by uuid
Delete external issue by uuid
Delete an external issue.
Delete project by id
Delete project by id
Schedules a project for deletion. deletion happens asynchronously and therefore is not immediate. however once deletion has begun the state of a project changes and will be hidden from most public views.
Delete project hook
Delete project hook
Remove a service hook.
Delete project key
Delete project key
Delete a client key for a given project.
Delete external team by id
Delete external team by id
Delete the link between a team from an external provider and a sentry team.
Add organization member via email
Add organization member via email
Add or invite a member to an organization.
Delete org notification action
Delete org notification action
Deletes a spike protection notification action. notification actions notify a set of members when an action has been triggered through a notification service such as slack or sentry. for example, organization owners and managers can receive an email when a spike occurs.
Create project webhook subscription
Create project webhook subscription
Register a new service hook on a project. events include: - event.alert: an alert is generated for an event (via rules). - event.created: a new event has been processed. this endpoint requires the ‘servicehooks’ feature to be enabled for your project.
Delete team by organization or team slug
Delete team by organization or team slug
Schedules a team for deletion. note: deletion happens asynchronously and therefore is not immediate. teams will have their slug released while waiting for deletion.
Add remove user email by id
Add remove user email by id
Add a secondary email address to account
Delete project issues
Delete project issues
Permanently remove the given issues. the list of issues to modify is given through the
id query parameter. it is repeated for each issue that should be removed. only queries by ‘id’ are accepted. if any ids are out of scope this operation will succeed without any data mutation.Delete external user from organization
Delete external user from organization
Delete the link between a user from an external provider and a sentry user.
Delete release file
Delete release file
Delete a file for a given release.
Delete project team association
Delete project team association
Revoke a team’s access to a project. note that team admins can only revoke access to teams they are admins of.
Delete team from org scim v2
Delete team from org scim v2
Delete a team with a scim group delete request.
Delete member from team
Delete member from team
Delete an organization member from a team.
Delete release file by id
Delete release file by id
Delete a file for a given release.
Fetch issue event by id
Fetch issue event by id
Retrieves the details of an issue event.
Delete user from org
Delete user from org
Delete an organization member with a scim user delete request.
Delete user emails by id
Delete user emails by id
Removes an email associated with the user account
Delete project monitor
Delete project monitor
Delete a monitor or monitor environments.
Add team member in organization
Add team member in organization
Add an organization member to a team.
Delete organization integration
Delete organization integration
Organizationintegrationbaseendpoints expect both integration and organizationintegration db entries to exist for a given organization and integration id.
Add team to project
Add team to project
Give a team access to a project.
Fetch organization replay count
Fetch organization replay count
Return a count of replays for the given issue or transaction id.
Delete organization alert rule
Delete organization alert rule
Delete a specific metric alert rule. a metric alert rule is a configuration that defines the conditions for triggering an alert. it specifies the metric type, function, time interval, and threshold values that determine when an alert should be triggered. metric alert rules are used to monitor and notify you when certain metrics, like error count, latency, or failure rate, cross a predefined threshold. these rules help you proactively identify and address issues in your project.
Fetch project environment details
Fetch project environment details
Return details on a project environment.
Fetch organization release threshold statuses
Fetch organization release threshold statuses
[warning]: this api is an experimental alpha feature and is subject to change! list all derived statuses of releases that fall within the provided start/end datetimes. constructs a response key’d off {release version}-{project slug} that lists thresholds with their status for specified projects. each returned enriched threshold will contain the full serialized release threshold instance as well as it’s derived health statuses.Fetch project release files
Fetch project release files
Return a list of files for a given release.
Fetch replay recording segment
Fetch replay recording segment
Return a replay recording segment.
Create release deploy for org
Create release deploy for org
Create a deploy.
Fetch tag values for issue
Fetch tag values for issue
Returns a list of values associated with this key for an issue. returns at most 1000 values when paginated.
Get activation of alert rule for organization
Get activation of alert rule for organization
Return a list of activations for a metric alert rule. an activation represents a single instance of an activated alert rule being triggered. it contains a date added field which represents the time the alert was triggered. activations can be filtered by start and end parameters to return activations with date added that falls within the specified time window.
Delete project rule
Delete project rule
Delete a specific issue alert rule.
Get integration details by org
Get integration details by org
Organizationintegrationbaseendpoints expect both integration and organizationintegration db entries to exist for a given organization and integration id.
Delete project replay
Delete project replay
Delete a replay.
Fetch organization alert rules
Fetch organization alert rules
Return a list of active metric alert rules bound to an organization. a metric alert rule is a configuration that defines the conditions for triggering an alert. it specifies the metric type, function, time interval, and threshold values that determine when an alert should be triggered. metric alert rules are used to monitor and notify you when certain metrics, like error count, latency, or failure rate, cross a predefined threshold. these rules help you proactively identify and address issues in your project.
Fetch project ownership details
Fetch project ownership details
Returns details on a project’s ownership configuration.
Fetch organization replay selectors
Fetch organization replay selectors
Return a list of selectors for a given organization.
Create sentry external issue link
Create sentry external issue link
Create or update an external issue from an integration platform integration.
Create team project for organization
Create team project for organization
Create a new project bound to a team.
Delete organization monitor
Delete organization monitor
Delete a monitor or monitor environments.
Delete project symbol sources
Delete project symbol sources
Delete a custom symbol source from a project.
Fetch organization replay details
Fetch organization replay details
Return details on an individual replay.
Create release for organization
Create release for organization
Create a new release for the given organization. releases are used by sentry to improve its error reporting abilities by correlating first seen events with the release that might have introduced the problem. releases are also necessary for source maps and other debug features that require manual upload for functioning well.
Fetch project replay clicks
Fetch project replay clicks
Retrieve a collection of rrweb dom node-ids and the timestamp they were clicked.
Delete organization member
Delete organization member
Remove an organization member.
Delete organization issue
Delete organization issue
Removes an individual issue.
Create scim group for organization
Create scim group for organization
Create a new team bound to an organization via a scim groups post request. the slug will have a normalization of uppercases/spaces to lowercases and dashes. note that teams are always created with an empty member set.
Get organization monitor by id or slug
Get organization monitor by id or slug
Retrieves details for a monitor.
Get organization environments
Get organization environments
Lists an organization’s environments.
Get organization details
Get organization details
Return a list of organizations available to the authenticated session in a region. this is particularly useful for requests with a user bound context. for api key-based requests this will only return the organization that belongs to the key.
List organization user teams
List organization user teams
Returns a list of teams the user has access to in the specified organization. note that this endpoint is restricted to user auth tokens.
Get organization release version
Get organization release version
Return details on an individual release.
Get project list
Get project list
Return a list of projects available to the authenticated session.
Get project events
Get project events
Return a list of events bound to a project.
Get organization by id or slug
Get organization by id or slug
Return details on an individual organization, including various details such as membership access and teams.
Get organization issue details
Get organization issue details
Return details on an individual issue. this returns the basic stats for the issue (title, last seen, first seen), some overall numbers (number of comments, user reports) as well as the summarized event data.
Retrieve monitor checkins
Retrieve monitor checkins
Retrieve a list of check-ins for a monitor
Retrieve notification action by org id
Retrieve notification action by org id
Returns a serialized spike protection notification action object. notification actions notify a set of members when an action has been triggered through a notification service such as slack or sentry. for example, organization owners and managers can receive an email when a spike occurs.
Retrieve issue tag details
Retrieve issue tag details
Return a list of values associated with this key for an issue. when paginated can return at most 1000 values.
Retrieve monitor checkins by org
Retrieve monitor checkins by org
Retrieve a list of check-ins for a monitor
Retrieve issue events by id
Retrieve issue events by id
Return a list of error events bound to an issue
Patch user active status in organization
Patch user active status in organization
Update an organization member’s attributes with a scim patch request.
Get project monitor by id
Get project monitor by id
Retrieves details for a monitor.
Retrieve issue hashes for organization
Retrieve issue hashes for organization
This endpoint lists an issue’s hashes, which are the generated checksums used to aggregate individual events.
Retrieve organization relay usage
Retrieve organization relay usage
Return a list of trusted relays bound to an organization. if the organization doesn’t have relay usage enabled it returns a 404.
Retrieve project event by id
Retrieve project event by id
Return details on an individual event.
List project users
List project users
Return a list of users seen within this project.
Retrieve organization release commits
Retrieve organization release commits
List an organization release’s commits.
Retrieve project release file details
Retrieve project release file details
Retrieve a file for a given release.
Get scim group by team id
Get scim group by team id
Query an individual team with a scim group get request. - note that the members field will only contain up to 10000 members.
Retrieve project hooks
Retrieve project hooks
Return a list of service hooks bound to a project.
List teams in organization
List teams in organization
Returns a list of teams bound to a organization.
Retrieve project filter data
Retrieve project filter data
Retrieve a list of filters for a given project.
active will be either a boolean or a list for the legacy browser filters.Post project symbol sources
Post project symbol sources
Add a custom symbol source to a project.
Retrieve project members list
Retrieve project members list
Returns a list of active organization members that belong to any team assigned to the project.
Retrieve project keys by org and project
Retrieve project keys by org and project
Return a list of client keys bound to a project.
Retrieve organization dashboard
Retrieve organization dashboard
Return details about an organization’s custom dashboard.
Get project rule details
Get project rule details
Return details on an individual issue alert rule. an issue alert rule triggers whenever a new event is received for any issue in a project that matches the specified alert conditions. these conditions can include a resolved issue re-appearing or an issue affecting many users. alert conditions have three parts: - triggers - specify what type of activity you’d like monitored or when an alert should be triggered. - filters - help control noise by triggering an alert only if the issue matches the specified criteria. - actions - specify what should happen when the trigger conditions are met and the filters match.
Retrieve project key details
Retrieve project key details
Return a client key bound to a project.
List scim v2 organization users
List scim v2 organization users
Returns a paginated list of members bound to a organization with a scim users get request.
Retrieve project issues list
Retrieve project issues list
Return a list of issues (groups) bound to a project. all parameters are supplied as query string parameters. a default query of
is:unresolved is applied. to return results with other statuses send an new query value (i.e. ?query= for all results). the statsperiod parameter can be used to select the timeline stats which should be present. possible values are: "" (disable),"24h" (default), "14d" user feedback items from the user feedback widget are built off the issue platform, so to return a list of user feedback items for a specific project, filter for issue.category:feedback.Retrieve project rules by org and project id
Retrieve project rules by org and project id
Return a list of active issue alert rules bound to a project. an issue alert rule triggers whenever a new event is received for any issue in a project that matches the specified alert conditions. these conditions can include a resolved issue re-appearing or an issue affecting many users. alert conditions have three parts: - triggers: specify what type of activity you’d like monitored or when an alert should be triggered. - filters: help control noise by triggering an alert only if the issue matches the specified criteria. - actions: specify what should happen when the trigger conditions are met and the filters match.
Get Project Event Stats
Get Project Event Stats
Return a set of points representing a normalized timestamp and the number of events seen in the period. query ranges are limited to sentry’s configured time-series resolutions.
Get organization sessions
Get organization sessions
Returns a time series of release health session statistics for projects bound to an organization. the interval and date range are subject to certain restrictions and rounding rules. the date range is rounded to align with the interval, and is rounded to at least one hour. the interval can at most be one day and at least one hour currently. it has to cleanly divide one day, for rounding reasons. because of technical limitations, this endpoint returns at most 10000 data points. for example, if you select a 90 day window grouped by releases, you will see at most
floor(10k / (90 + 1)) = 109 releases. to get more results, reduce the statsperiod.Retrieve project tag values
Retrieve project tag values
Return a list of values associated with this key. the
query parameter can be used to perform a “contains” match on values. when paginated can return at most 1000 values.Retrieve organization events
Retrieve organization events
Retrieves discover (also known as events) data for a given organization.
Post spike protection for organization
Post spike protection for organization
Enables spike protection feature for some of the projects within the organization.
Get team members by id or slug
Get team members by id or slug
List all members on a team. the response will not include members with pending invites.
Retrieve saved discover query for organization
Retrieve saved discover query for organization
Retrieve a saved query.
Get who viewed replay by project
Get who viewed replay by project
Return a list of users who have viewed a replay.
Retrieve saved discover queries
Retrieve saved discover queries
Retrieve a list of saved queries that are associated with the given organization.
Retrieve replay recording segments
Retrieve replay recording segments
Return a collection of replay recording segments.
Retrieve project symbol sources
Retrieve project symbol sources
List custom symbol sources configured for a project.
Retrieve alert rule details
Retrieve alert rule details
Return details on an individual metric alert rule. a metric alert rule is a configuration that defines the conditions for triggering an alert. it specifies the metric type, function, time interval, and threshold values that determine when an alert should be triggered. metric alert rules are used to monitor and notify you when certain metrics, like error count, latency, or failure rate, cross a predefined threshold. these rules help you proactively identify and address issues in your project.
Retrieve release deployments
Retrieve release deployments
Return a list of deploys for a given release.
Get sentry app installations for organization
Get sentry app installations for organization
Return a list of integration platform installations for a given organization.
Retrieve release file by id
Retrieve release file by id
Retrieve a file for a given release.
Retrieve commits for organization repo
Retrieve commits for organization repo
Return a list of commits for a given repository.
Retrieve source map debug event
Retrieve source map debug event
Return a list of source map errors for a given event.
Retrieve project teams
Retrieve project teams
Return a list of teams that have access to this project.
Retrieve commit files for release
Retrieve commit files for release
Retrieve files changed in a release’s commits
Retrieve short id for organization
Retrieve short id for organization
This resolves a short id to the project slug and internal issue id.
Get project hook
Get project hook
Return a service hook bound to a project.
List organization dashboards
List organization dashboards
Retrieve a list of custom dashboards that are associated with the given organization.
Retrieve organization integrations list
Retrieve organization integrations list
Lists all the available integrations for an organization.
Retrieve user email information
Retrieve user email information
Returns a list of emails. primary email will have
isprimary: trueRetrieve team projects
Retrieve team projects
Return a list of projects bound to a team.
List organization members
List organization members
List all organization members. response includes pending invites that are approved by organization owners or managers but waiting to be accepted by the invitee.
Switch team role for member
Switch team role for member
The relevant organization member must already be a part of the team. note that for organization admins, managers, and owners, they are automatically granted a minimum team role of
admin on all teams they are part of. read more about team roles.Toggle project filter status
Toggle project filter status
Update various inbound data filters for a project.
Manage team external integrations
Manage team external integrations
Link a team from an external provider to a sentry team.
Update environment visibility
Update environment visibility
Update the visibility for a project environment.
Save organization discover query
Save organization discover query
Create a new saved query for the given organization.
Retrieve user feedback for project
Retrieve user feedback for project
Return a list of user feedback items within this project. this list does not include submissions from the user feedback widget. this is because it is based on an older format called user reports - read more here. to return a list of user feedback items from the widget, please use the issue api with the filter
issue.category:feedback.*Update external user for organization
Update external user for organization
Update a user in an external provider that is currently linked to a sentry user.
Update external team integration
Update external team integration
Update a team in an external provider that is currently linked to a sentry team.
Retrieve user via scim api
Retrieve user via scim api
Query an individual organization member with a scim user get request. - the
name object will contain fields firstname and lastname with the values of n/a. sentry’s scim api does not currently support these fields but returns them for compatibility purposes.List organization releases
List organization releases
Return a list of releases for a given organization.
Retrieve release commits
Retrieve release commits
List a project release’s commits.
Retrieve organization replays
Retrieve organization replays
Return a list of replays belonging to an organization.
Retrieve team info via organization id or slug
Retrieve team info via organization id or slug
Return details on an individual team.
Submit notification action api data
Submit notification action api data
Creates a new notification action for spike protection. notification actions notify a set of members when an action has been triggered through a notification service such as slack or sentry. for example, organization owners and managers can receive an email when a spike occurs.
Submit project user feedback
Submit project user feedback
this endpoint is deprecated. we document it here for older sdks and users who are still migrating to the user feedback widget or api(multi-platform). if you are a new user, do not use this endpoint - unless you don’t have a js frontend, and your platform’s sdk does not offer a feedback api. feedback must be received by the server no more than 30 minutes after the event was saved. additionally, within 5 minutes of submitting feedback it may also be overwritten. this is useful in situations where you may need to retry sending a request due to network failures. if feedback is rejected due to a mutability threshold, a 409 status code will be returned. note: feedback may be submitted with dsn authentication (see auth documentation).
Retrieve organization member
Retrieve organization member
Retrieve an organization member’s details. response will be a pending invite if it has been approved by organization owners or managers but is waiting to be accepted by the invitee.
Update issue attributes in organization
Update issue attributes in organization
Updates an individual issue’s attributes. only the attributes submitted are modified.
Update project details
Update project details
Update various attributes and configurable settings for the given project. note that solely having the
project:read scope restricts updatable settings to isbookmarked.Update organization member role
Update organization member role
Update a member’s organization-level and team-level roles. note that for changing organization-roles, this endpoint is restricted to user auth tokens. additionally, both the original and desired organization role must have the same or lower permissions than the role of the organization user making the request for example, an organization manager may change someone’s role from member to manager, but not to owner.
Modify organization notification action
Modify organization notification action
Updates a spike protection notification action. notification actions notify a set of members when an action has been triggered through a notification service such as slack or sentry. for example, organization owners and managers can receive an email when a spike occurs.
Retrieve dsym files for project
Retrieve dsym files for project
Retrieve a list of debug information files for a given project.
List organization repositories
List organization repositories
Return a list of version control repositories for a given organization.
Modify organization monitor data
Modify organization monitor data
Update a monitor.
Update organization alert rules
Update organization alert rules
Updates a metric alert rule. see metric alert rule types under create a metric alert rule for an organization to see valid request body configurations for different types of metric alert rule types. > warning: calling this endpoint fully overwrites the specified metric alert. a metric alert rule is a configuration that defines the conditions for triggering an alert. it specifies the metric type, function, time interval, and threshold values that determine when an alert should be triggered. metric alert rules are used to monitor and notify you when certain metrics, like error count, latency, or failure rate, cross a predefined threshold. these rules help you proactively identify and address issues in your project.
Update project key configuration
Update project key configuration
Update various settings for a client key.
Patch scim group operations
Patch scim group operations
Update a team’s attributes with a scim group patch request.
Retrieve files for release
Retrieve files for release
Return a list of files for a given release.
Get organization stats summary
Get organization stats summary
Query summarized event counts by project for your organization. also see https://docs.sentry.io/api/organizations/retrieve-event-counts-for-an-organization-v2/ for reference.
Update project issue status and details
Update project issue status and details
Bulk mutate various attributes on issues. the list of issues to modify is given through the
id query parameter. it is repeated for each issue that should be modified. - for non-status updates, the id query parameter is required. - for status updates, the id query parameter may be omitted for a batch “update all” query. - an optional status query parameter may be used to restrict mutations to only events with the given status. the following attributes can be modified and are supplied as json object in the body: if any ids are out of scope this operation will succeed without any data mutation.Update organization dashboard
Update organization dashboard
Edit an organization’s custom dashboard as well as any bulk edits on widgets that may have been made. (for example, widgets that have been rearranged, updated queries and fields, specific display types, and so on.)
Retrieve org integration config
Retrieve org integration config
Get integration provider information about all available integrations for an organization.
Retrieve event id for organization
Retrieve event id for organization
This resolves an event id to the project slug and internal issue id and internal event id.
Modify release file attributes
Modify release file attributes
Update an organization release file.
Retrieve organization monitors
Retrieve organization monitors
Lists monitors, including nested monitor environments. may be filtered to a project or environment.
Retrieve organization scim groups
Retrieve organization scim groups
Returns a paginated list of teams bound to a organization with a scim groups get request. note that the members field will only contain up to 10,000 members.
Retrieve project environments
Retrieve project environments
Lists a project’s environments.
Retrieve organization stats v2
Retrieve organization stats v2
Query event counts for your organization. select a field, define a date range, and group or filter by columns.
Retrieve organization projects
Retrieve organization projects
Return a list of projects bound to a organization.
Modify organization settings
Modify organization settings
Update various attributes and configurable settings for the given organization.
Update webhook configuration xp
Update webhook configuration xp
Update a service hook.
Update project rule by id
Update project rule by id
Updates an issue alert rule. > warning: calling this endpoint fully overwrites the specified issue alert. an issue alert rule triggers whenever a new event is received for any issue in a project that matches the specified alert conditions. these conditions can include a resolved issue re-appearing or an issue affecting many users. alert conditions have three parts: - triggers - specify what type of activity you’d like monitored or when an alert should be triggered. - filters - help control noise by triggering an alert only if the issue matches the specified criteria. - actions - specify what should happen when the trigger conditions are met and the filters match.
Update project release file details
Update project release file details
Update a project release file.
Update saved query for organization
Update saved query for organization
Modify a saved query.
Upload file to project release
Upload file to project release
Upload a new file for the given release. unlike other api requests, files must be uploaded using the traditional multipart/form-data content-type. requests to this endpoint should use the region-specific domain eg.
us.sentry.io or de.sentry.io the optional ‘name’ attribute should reflect the absolute path that this file will be referenced as. for example, in the case of javascript you might specify the full web uri.Update project ownership settings
Update project ownership settings
Updates ownership configurations for a project. note that only the attributes submitted are modified.
Update release details for organization
Update release details for organization
Update a release. this can change some metadata associated with the release (the ref, url, and dates).
Update project monitor
Update project monitor
Update a monitor.
Update team information by organization id
Update team information by organization id
Update various attributes and configurable settings for the given team.
Update user email
Update user email
Update a primary email address
Upload release file to organization
Upload release file to organization
Upload a new file for the given release. unlike other api requests, files must be uploaded using the traditional multipart/form-data content-type. requests to this endpoint should use the region-specific domain eg.
us.sentry.io or de.sentry.io. the optional ‘name’ attribute should reflect the absolute path that this file will be referenced as. for example, in the case of javascript you might specify the full web uri.Upload dsyms file to project
Upload dsyms file to project
Upload a new debug information file for the given release. unlike other api requests, files must be uploaded using the traditional multipart/form-data content-type. requests to this endpoint should use the region-specific domain eg.
us.sentry.io or de.sentry.io. the file uploaded is a zip archive of an apple .dsym folder which contains the individual debug images. uploading through this endpoint will create different files for the contained images.Update symbol source settings
Update symbol source settings
Update a custom symbol source in a project.
View organization notification actions
View organization notification actions
Returns all spike protection notification actions for an organization. notification actions notify a set of members when an action has been triggered through a notification service such as slack or sentry. for example, organization owners and managers can receive an email when a spike occurs. you can use either the
project or projectslug query parameter to filter for certain projects. note that if both are present, projectslug takes priority.