Sentry

Learn how to use Sentry with Composio

Overview

Enum

SENTRY

Description

Integrate Sentry to manage your error tracking and monitoring.

Authentication Details

token
stringRequired
base_url
stringDefaults to https://sentry.io

Actions

Retrieves discover (also known as events) data for a given organization.

Action Parameters

organization_id_or_slug
stringRequired
field
arrayRequired
end
string
environment
array
project
array
start
string
statsPeriod
string
per_page
integer
query
string
sort
string

Action Response

data
object
successful
boolean
error

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.

Action Parameters

organization_id_or_slug
stringRequired
project_id_or_slug
stringRequired

Action Response

data
object
successful
boolean
error

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.

Action Parameters

organization_id_or_slug
stringRequired
action_id
integerRequired

Action Response

data
object
successful
boolean
error

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.

Action Parameters

organization_id_or_slug
stringRequired
project_id_or_slug
stringRequired
id
integer

Action Response

data
object
successful
boolean
error

Return a list of selectors for a given organization.

Action Parameters

organization_id_or_slug
stringRequired
environment
array
statsPeriod
string
start
string
end
string
project
array
sort
string
cursor
string
per_page
integer
query
string

Action Response

data
object
successful
boolean
error

Give a team access to a project.

Action Parameters

organization_id_or_slug
stringRequired
project_id_or_slug
stringRequired
team_id_or_slug
stringRequired

Action Response

data
object
successful
boolean
error

Return a list of events bound to a project.

Action Parameters

organization_id_or_slug
stringRequired
project_id_or_slug
stringRequired
cursor
string
full
boolean
sample
boolean

Action Response

data
object
successful
boolean
error

Update a service hook.

Action Parameters

organization_id_or_slug
stringRequired
project_id_or_slug
stringRequired
hook_id
stringRequired
url
stringRequired
events
arrayRequired

Action Response

data
object
successful
boolean
error

Create a new organization member via a scim users post request. note that this api does not support setting secondary emails.

Action Parameters

organization_id_or_slug
stringRequired
userName
stringRequired
sentryOrgRole
string

Action Response

data
object
successful
boolean
error

List an organization release’s commits.

Action Parameters

organization_id_or_slug
stringRequired
version
stringRequired

Action Response

data
object
successful
boolean
error

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.

Action Parameters

organization_id_or_slug
stringRequired
project_id_or_slug
stringRequired

Action Response

data
object
successful
boolean
error

Retrieve a file for a given release.

Action Parameters

organization_id_or_slug
stringRequired
version
stringRequired
file_id
stringRequired
download
boolean

Action Response

data
object
successful
boolean
error

Return details on a project environment.

Action Parameters

organization_id_or_slug
stringRequired
project_id_or_slug
stringRequired
environment
stringRequired

Action Response

data
object
successful
boolean
error

Lists a project’s environments.

Action Parameters

organization_id_or_slug
stringRequired
project_id_or_slug
stringRequired
visibility
string

Action Response

data
object
successful
boolean
error

Retrieve a saved query.

Action Parameters

organization_id_or_slug
stringRequired
query_id
integerRequired

Action Response

data
object
successful
boolean
error

Return details on an individual team.

Action Parameters

organization_id_or_slug
stringRequired
team_id_or_slug
stringRequired
expand
string
collapse
string

Action Response

data
object
successful
boolean
error

Lists monitors, including nested monitor environments. may be filtered to a project or environment.

Action Parameters

organization_id_or_slug
stringRequired
project
array
environment
array
owner
string

Action Response

data
object
successful
boolean
error

Retrieve a list of saved queries that are associated with the given organization.

Action Parameters

organization_id_or_slug
stringRequired
per_page
integer
cursor
string
query
string
sortBy
string

Action Response

data
object
successful
boolean
error

Remove a service hook.

Action Parameters

organization_id_or_slug
stringRequired
project_id_or_slug
stringRequired
hook_id
stringRequired

Action Response

data
object
successful
boolean
error

Delete a client key for a given project.

Action Parameters

organization_id_or_slug
stringRequired
project_id_or_slug
stringRequired
key_id
stringRequired

Action Response

data
object
successful
boolean
error

Removes an email associated with the user account

Action Parameters

user_id
stringRequired

Action Response

data
object
successful
boolean
error

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.*

Action Parameters

organization_id_or_slug
stringRequired
project_id_or_slug
stringRequired

Action Response

data
object
successful
boolean
error

Returns a paginated list of members bound to a organization with a scim users get request.

Action Parameters

organization_id_or_slug
stringRequired
startIndex
integerDefaults to 1
count
integerDefaults to 100
filter
string
excludedAttributes
array

Action Response

data
object
successful
boolean
error

Update a release. this can change some metadata associated with the release (the ref, url, and dates).

Action Parameters

organization_id_or_slug
stringRequired
version
stringRequired
ref
string
url
string
dateReleased
string
commits
array
refs
array

Action Response

data
object
successful
boolean
error

Return a list of teams that have access to this project.

Action Parameters

organization_id_or_slug
stringRequired
project_id_or_slug
stringRequired

Action Response

data
object
successful
boolean
error

Return details on an individual event.

Action Parameters

organization_id_or_slug
stringRequired
project_id_or_slug
stringRequired
event_id
stringRequired

Action Response

data
object
successful
boolean
error

[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.

Action Parameters

organization_id_or_slug
stringRequired
start
stringRequired
end
stringRequired
environment
array
projectSlug
array
release
array

Action Response

data
object
successful
boolean
error

Returns a list of teams bound to a organization.

Action Parameters

organization_id_or_slug
stringRequired
detailed
string
cursor
string

Action Response

data
object
successful
boolean
error

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.

Action Parameters

organization_id_or_slug
stringRequired
project_id_or_slug
stringRequired
rule_id
integerRequired

Action Response

data
object
successful
boolean
error

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.

Action Parameters

organization_id_or_slug
stringRequired
name
stringRequired
aggregate
stringRequired
timeWindow
integerRequired
projects
arrayRequired
query
stringRequired
thresholdType
integerRequired
triggers
arrayRequired
environment
string
dataset
string
queryType
integer
eventTypes
array
comparisonDelta
integer
resolveThreshold
integer
owner
string
monitorType
integer
activationCondition
integer

Action Response

data
object
successful
boolean
error

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.

Action Parameters

organization_id_or_slug
stringRequired
field
arrayRequired
start
string
end
string
environment
array
statsPeriod
string
project
array
per_page
integer
interval
string
groupBy
array
orderBy
string
includeTotals
integer
includeSeries
integer
query
string

Action Response

data
object
successful
boolean
error

Returns a list of values associated with this key for an issue. returns at most 1000 values when paginated.

Action Parameters

issue_id
integerRequired
key
stringRequired
sort
string
environment
array

Action Response

data
object
successful
boolean
error

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.

Action Parameters

organization_id_or_slug
stringRequired
issue_id
stringRequired

Action Response

data
object
successful
boolean
error

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.

Action Parameters

organization_id_or_slug
stringRequired
project_id_or_slug
stringRequired
version
stringRequired
file
object
name
string
dist
string
header
string

Action Response

data
object
successful
boolean
error

Delete a replay.

Action Parameters

organization_id_or_slug
stringRequired
project_id_or_slug
stringRequired
replay_id
stringRequired

Action Response

data
object
successful
boolean
error

Revoke a team’s access to a project. note that team admins can only revoke access to teams they are admins of.

Action Parameters

organization_id_or_slug
stringRequired
project_id_or_slug
stringRequired
team_id_or_slug
stringRequired

Action Response

data
object
successful
boolean
error

Delete a monitor or monitor environments.

Action Parameters

organization_id_or_slug
stringRequired
monitor_id_or_slug
stringRequired
environment
array

Action Response

data
object
successful
boolean
error

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.

Action Parameters

organization_id_or_slug
stringRequired
member_id
stringRequired
team_id_or_slug
stringRequired
teamRole
stringDefaults to contributor

Action Response

data
object
successful
boolean
error

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.

Action Parameters

organization_id_or_slug
stringRequired
alert_rule_id
integerRequired

Action Response

data
object
successful
boolean
error

Update a team’s attributes with a scim group patch request.

Action Parameters

organization_id_or_slug
stringRequired
team_id
integerRequired
Operations
arrayRequired

Action Response

data
object
successful
boolean
error

Add a secondary email address to account

Action Parameters

user_id
stringRequired
email
stringRequired

Action Response

data
object
successful
boolean
error

Permanently remove a release and all of its files.

Action Parameters

organization_id_or_slug
stringRequired
version
stringRequired

Action Response

data
object
successful
boolean
error

This endpoint lists an issue’s hashes, which are the generated checksums used to aggregate individual events.

Action Parameters

organization_id_or_slug
stringRequired
issue_id
stringRequired
full
booleanDefaults to True
cursor
string

Action Response

data
object
successful
boolean
error

Create a new team bound to an organization. requires at least one of the name or slug body params to be set.

Action Parameters

organization_id_or_slug
stringRequired
slug
string
name
string

Action Response

data
object
successful
boolean
error

Return a list of trusted relays bound to an organization. if the organization doesn’t have relay usage enabled it returns a 404.

Action Parameters

organization_id_or_slug
stringRequired

Action Response

data
object
successful
boolean
error

Delete a monitor or monitor environments.

Action Parameters

organization_id_or_slug
stringRequired
project_id_or_slug
stringRequired
monitor_id_or_slug
stringRequired
environment
array

Action Response

data
object
successful
boolean
error

Create a new client key bound to a project. the key’s secret and public key are generated by the server.

Action Parameters

organization_id_or_slug
stringRequired
project_id_or_slug
stringRequired
name
string
rateLimit__count
integer
rateLimit__window
integer

Action Response

data
object
successful
boolean
error

Delete the link between a team from an external provider and a sentry team.

Action Parameters

organization_id_or_slug
stringRequired
team_id_or_slug
stringRequired
external_team_id
integerRequired

Action Response

data
object
successful
boolean
error

Return a list of error events bound to an issue

Action Parameters

issue_id
integerRequired
start
string
end
string
statsPeriod
string
environment
array
full
boolean
sample
boolean
query
string

Action Response

data
object
successful
boolean
error

Return a list of client keys bound to a project.

Action Parameters

organization_id_or_slug
stringRequired
project_id_or_slug
stringRequired
cursor
string
status
string

Action Response

data
object
successful
boolean
error

Return a list of values associated with this key for an issue. when paginated can return at most 1000 values.

Action Parameters

issue_id
integerRequired
key
stringRequired
environment
array

Action Response

data
object
successful
boolean
error

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.

Action Parameters

organization_id_or_slug
stringRequired
project_id_or_slug
stringRequired
rule_id
integerRequired
name
stringRequired
actionMatch
stringRequired
conditions
arrayRequired
actions
arrayRequired
frequency
integerRequired
environment
string
filterMatch
string
filters
array
owner
string

Action Response

data
object
successful
boolean
error

Add an organization member to a team.

Action Parameters

organization_id_or_slug
stringRequired
member_id
stringRequired
team_id_or_slug
stringRequired

Action Response

data
object
successful
boolean
error

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.

Action Parameters

organization_id_or_slug
stringRequired
alert_rule_id
integerRequired

Action Response

data
object
successful
boolean
error

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.

Action Parameters

organization_id_or_slug
stringRequired
project_id_or_slug
stringRequired
file
object

Action Response

data
object
successful
boolean
error

Return a list of values associated with this key. the query parameter can be used to to perform a “contains” match on values. when paginated can return at most 1000 values.

Action Parameters

organization_id_or_slug
stringRequired
project_id_or_slug
stringRequired
key
stringRequired

Action Response

data
object
successful
boolean
error

Update an organization release file.

Action Parameters

organization_id_or_slug
stringRequired
version
stringRequired
file_id
stringRequired
name
string
dist
string

Action Response

data
object
successful
boolean
error

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.

Action Parameters

organization_id_or_slug
stringRequired
version
stringRequired
projects
arrayRequired
ref
string
url
string
dateReleased
string
commits
array
refs
array

Action Response

data
object
successful
boolean
error

Update various inbound data filters for a project.

Action Parameters

organization_id_or_slug
stringRequired
project_id_or_slug
stringRequired
filter_id
stringRequired
active
boolean
subfilters
array

Action Response

data
object
successful
boolean
error

Query event counts for your organization. select a field, define a date range, and group or filter by columns.

Action Parameters

organization_id_or_slug
stringRequired
groupBy
arrayRequired
field
stringRequired
statsPeriod
string
interval
string
start
string
end
string
project
array
category
string
outcome
string
reason
string

Action Response

data
object
successful
boolean
error

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.

Action Parameters

organization_id_or_slug
stringRequired

Action Response

data
object
successful
boolean
error

Return details about an organization’s custom dashboard.

Action Parameters

organization_id_or_slug
stringRequired
dashboard_id
integerRequired

Action Response

data
object
successful
boolean
error

Update a team in an external provider that is currently linked to a sentry team.

Action Parameters

organization_id_or_slug
stringRequired
team_id_or_slug
stringRequired
external_team_id
integerRequired
external_name
stringRequired
provider
stringRequired
integration_id
integerRequired
external_id
string

Action Response

data
object
successful
boolean
error

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.

Action Parameters

organization_id_or_slug
stringRequired
action_id
integerRequired

Action Response

data
object
successful
boolean
error

Return a list of projects available to the authenticated session.

Action Parameters

cursor
string

Action Response

data
object
successful
boolean
error

Return a list of files for a given release.

Action Parameters

organization_id_or_slug
stringRequired
version
stringRequired

Action Response

data
object
successful
boolean
error

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.)

Action Parameters

organization_id_or_slug
stringRequired
dashboard_id
integerRequired
id
string
title
string
widgets
array
projects
array
environment
array
period
string
start
string
end
string
filters
object
utc
boolean

Action Response

data
object
successful
boolean
error

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.

Action Parameters

organization_id_or_slug
stringRequired
project_id_or_slug
stringRequired
stat
string
since
string
until
string
resolution
string

Action Response

data
object
successful
boolean
error

Return a list of files for a given release.

Action Parameters

organization_id_or_slug
stringRequired
project_id_or_slug
stringRequired
version
stringRequired

Action Response

data
object
successful
boolean
error

Enables spike protection feature for some of the projects within the organization.

Action Parameters

organization_id_or_slug
stringRequired
projects
arrayRequired

Action Response

data
object
successful
boolean
error

Create a new dashboard for the given organization

Action Parameters

organization_id_or_slug
stringRequired
title
stringRequired
id
string
widgets
array
projects
array
environment
array
period
string
start
string
end
string
filters
object
utc
boolean

Action Response

data
object
successful
boolean
error

Delete a specific issue alert rule.

Action Parameters

organization_id_or_slug
stringRequired
project_id_or_slug
stringRequired
rule_id
integerRequired

Action Response

data
object
successful
boolean
error

Delete the link between a user from an external provider and a sentry user.

Action Parameters

organization_id_or_slug
stringRequired
external_user_id
integerRequired

Action Response

data
object
successful
boolean
error

List custom symbol sources configured for a project.

Action Parameters

organization_id_or_slug
stringRequired
project_id_or_slug
stringRequired
id
string

Action Response

data
object
successful
boolean
error

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.

Action Parameters

organization_id_or_slug
stringRequired
alert_rule_id
integerRequired
name
stringRequired
aggregate
stringRequired
timeWindow
integerRequired
projects
arrayRequired
query
stringRequired
thresholdType
integerRequired
triggers
arrayRequired
environment
string
dataset
string
queryType
integer
eventTypes
array
comparisonDelta
integer
resolveThreshold
integer
owner
string
monitorType
integer
activationCondition
integer

Action Response

data
object
successful
boolean
error

Delete a debug information file for a given project.

Action Parameters

organization_id_or_slug
stringRequired
project_id_or_slug
stringRequired
id
stringRequired

Action Response

data
object
successful
boolean
error

Return a list of users who have viewed a replay.

Action Parameters

organization_id_or_slug
stringRequired
project_id_or_slug
stringRequired
replay_id
stringRequired

Action Response

data
object
successful
boolean
error

Retrieves details for a monitor.

Action Parameters

organization_id_or_slug
stringRequired
monitor_id_or_slug
stringRequired
environment
array

Action Response

data
object
successful
boolean
error

Return a list of commits for a given repository.

Action Parameters

organization_id_or_slug
stringRequired
repo_id
stringRequired

Action Response

data
object
successful
boolean
error

Remove an organization member.

Action Parameters

organization_id_or_slug
stringRequired
member_id
stringRequired

Action Response

data
object
successful
boolean
error

Create a new monitor.

Action Parameters

organization_id_or_slug
stringRequired
name
stringRequired
type
stringRequired
slug
string
status
stringDefaults to active
owner
string
is_muted
boolean

Action Response

data
object
successful
boolean
error

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.

Action Parameters

organization_id_or_slug
stringRequired
project_id_or_slug
stringRequired
statsPeriod
string
shortIdLookup
boolean
query
string
hashes
string
cursor
string

Action Response

data
object
successful
boolean
error

Updates ownership configurations for a project. note that only the attributes submitted are modified.

Action Parameters

organization_id_or_slug
stringRequired
project_id_or_slug
stringRequired
raw
string
fallthrough
boolean
autoAssignment
string
codeownersAutoSync
booleanDefaults to True

Action Response

data
object
successful
boolean
error

Return a client key bound to a project.

Action Parameters

organization_id_or_slug
stringRequired
project_id_or_slug
stringRequired
key_id
stringRequired

Action Response

data
object
successful
boolean
error

Return a list of service hooks bound to a project.

Action Parameters

organization_id_or_slug
stringRequired
project_id_or_slug
stringRequired
cursor
string

Action Response

data
object
successful
boolean
error

Return a list of integration platform installations for a given organization.

Action Parameters

organization_id_or_slug
stringRequired

Action Response

data
object
successful
boolean
error

Return a service hook bound to a project.

Action Parameters

organization_id_or_slug
stringRequired
project_id_or_slug
stringRequired
hook_id
stringRequired

Action Response

data
object
successful
boolean
error

List a project release’s commits.

Action Parameters

organization_id_or_slug
stringRequired
project_id_or_slug
stringRequired
version
stringRequired

Action Response

data
object
successful
boolean
error

Update a custom symbol source in a project.

Action Parameters

organization_id_or_slug
stringRequired
project_id_or_slug
stringRequired
id
stringRequired
type
stringRequired
name
stringRequired
layout__type
string
layout__casing
string
url
string
username
string
password
string
bucket
string
region
string
access_key
string
secret_key
string
prefix
string
client_email
string
private_key
string

Action Response

data
object
successful
boolean
error

Update various attributes and configurable settings for the given organization.

Action Parameters

organization_id_or_slug
stringRequired
slug
string
name
string
isEarlyAdopter
boolean
hideAiFeatures
boolean
codecovAccess
boolean
defaultRole
string
openMembership
boolean
eventsMemberAdmin
boolean
alertsMemberWrite
boolean
attachmentsRole
string
debugFilesRole
string
avatarType
string
avatar
string
require2FA
boolean
allowSharedIssues
boolean
enhancedPrivacy
boolean
scrapeJavaScript
boolean
storeCrashReports
integer
allowJoinRequests
boolean
dataScrubber
boolean
dataScrubberDefaults
boolean
sensitiveFields
array
safeFields
array
scrubIPAddresses
boolean
relayPiiConfig
string
trustedRelays
array
githubPRBot
boolean
githubOpenPRBot
boolean
githubNudgeInvite
boolean
issueAlertsThreadFlag
boolean
metricAlertsThreadFlag
boolean
cancelDeletion
boolean

Action Response

data
object
successful
boolean
error

Retrieve a collection of rrweb dom node-ids and the timestamp they were clicked.

Action Parameters

organization_id_or_slug
stringRequired
project_id_or_slug
stringRequired
replay_id
stringRequired
cursor
string
environment
array
per_page
integer
query
string

Action Response

data
object
successful
boolean
error

List all organization members. response includes pending invites that are approved by organization owners or managers but waiting to be accepted by the invitee.

Action Parameters

organization_id_or_slug
stringRequired

Action Response

data
object
successful
boolean
error

Return details on an individual release.

Action Parameters

organization_id_or_slug
stringRequired
version
stringRequired
project_id
string
health
boolean
adoptionStages
boolean
summaryStatsPeriod
string
healthStatsPeriod
string
sort
string
status
string
query
string

Action Response

data
object
successful
boolean
error

Add a custom symbol source to a project.

Action Parameters

organization_id_or_slug
stringRequired
project_id_or_slug
stringRequired
type
stringRequired
name
stringRequired
id
string
layout__type
string
layout__casing
string
url
string
username
string
password
string
bucket
string
region
string
access_key
string
secret_key
string
prefix
string
client_email
string
private_key
string

Action Response

data
object
successful
boolean
error

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.

Action Parameters

organization_id_or_slug
stringRequired
member_id
stringRequired
orgRole
string
teamRoles
array

Action Response

data
object
successful
boolean
error

Delete a file for a given release.

Action Parameters

organization_id_or_slug
stringRequired
version
stringRequired
file_id
stringRequired

Action Response

data
object
successful
boolean
error

Retrieves details for a monitor.

Action Parameters

organization_id_or_slug
stringRequired
project_id_or_slug
stringRequired
monitor_id_or_slug
stringRequired

Action Response

data
object
successful
boolean
error

Delete a file for a given release.

Action Parameters

organization_id_or_slug
stringRequired
project_id_or_slug
stringRequired
version
stringRequired
file_id
stringRequired

Action Response

data
object
successful
boolean
error

Return a list of deploys for a given release.

Action Parameters

organization_id_or_slug
stringRequired
version
stringRequired

Action Response

data
object
successful
boolean
error

Return a list of replays belonging to an organization.

Action Parameters

organization_id_or_slug
stringRequired
statsPeriod
string
start
string
end
string
field
array
project
array
environment
string
sort
string
query
string
per_page
integer
cursor
string

Action Response

data
object
successful
boolean
error

Link a team from an external provider to a sentry team.

Action Parameters

organization_id_or_slug
stringRequired
team_id_or_slug
stringRequired
external_name
stringRequired
provider
stringRequired
integration_id
integerRequired
external_id
string

Action Response

data
object
successful
boolean
error

Update a primary email address

Action Parameters

user_id
stringRequired
email
stringRequired

Action Response

data
object
successful
boolean
error

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.

Action Parameters

organization_id_or_slug
stringRequired
version
stringRequired
file
object
name
string
dist
string
header
string

Action Response

data
object
successful
boolean
error

Return a list of source map errors for a given event.

Action Parameters

organization_id_or_slug
stringRequired
project_id_or_slug
stringRequired
event_id
stringRequired
frame_idx
integerRequired
exception_idx
integerRequired

Action Response

data
object
successful
boolean
error

Retrieves the details of an issue event.

Action Parameters

issue_id
integerRequired
event_id
stringRequired
environment
array

Action Response

data
object
successful
boolean
error

Update a monitor.

Action Parameters

organization_id_or_slug
stringRequired
project_id_or_slug
stringRequired
monitor_id_or_slug
stringRequired
name
stringRequired
type
stringRequired
slug
string
status
stringDefaults to active
owner
string
is_muted
boolean

Action Response

data
object
successful
boolean
error

Returns a list of active organization members that belong to any team assigned to the project.

Action Parameters

organization_id_or_slug
stringRequired
project_id_or_slug
stringRequired

Action Response

data
object
successful
boolean
error

Modify a saved query.

Action Parameters

organization_id_or_slug
stringRequired
query_id
integerRequired
name
stringRequired
projects
array
queryDataset
stringDefaults to error-events
start
string
end
string
range
string
fields
array
orderby
string
environment
array
query
string
yAxis
array
display
string
topEvents
integer
interval
string

Action Response

data
object
successful
boolean
error

Retrieve files changed in a release’s commits

Action Parameters

organization_id_or_slug
stringRequired
version
stringRequired

Action Response

data
object
successful
boolean
error

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.

Action Parameters

organization_id_or_slug
stringRequired
project_id_or_slug
stringRequired
id
integer
status
string
statusDetails__inRelease
string
statusDetails__inNextRelease
boolean
statusDetails__inCommit
string
statusDetails__ignoreDuration
integer
statusDetails__ignoreCount
integer
statusDetails__ignoreWindow
integer
statusDetails__ignoreUserCount
integer
statusDetails__ignoreUserWindow
integer
ignoreDuration
integer
isPublic
boolean
merge
boolean
assignedTo
string
hasSeen
boolean
isBookmarked
boolean

Action Response

data
object
successful
boolean
error

Return a replay recording segment.

Action Parameters

organization_id_or_slug
stringRequired
project_id_or_slug
stringRequired
replay_id
stringRequired
segment_id
integerRequired

Action Response

data
object
successful
boolean
error

Update a monitor.

Action Parameters

organization_id_or_slug
stringRequired
monitor_id_or_slug
stringRequired
name
stringRequired
type
stringRequired
slug
string
status
stringDefaults to active
owner
string
is_muted
boolean

Action Response

data
object
successful
boolean
error

Update various attributes and configurable settings for the given team.

Action Parameters

organization_id_or_slug
stringRequired
team_id_or_slug
stringRequired
slug
stringRequired

Action Response

data
object
successful
boolean
error

Returns a list of teams the user has access to in the specified organization. note that this endpoint is restricted to user auth tokens.

Action Parameters

organization_id_or_slug
stringRequired

Action Response

data
object
successful
boolean
error

Return a count of replays for the given issue or transaction id.

Action Parameters

organization_id_or_slug
stringRequired
environment
array
start
string
end
string
statsPeriod
string
project
array
query
string

Action Response

data
object
successful
boolean
error

Get integration provider information about all available integrations for an organization.

Action Parameters

organization_id_or_slug
stringRequired
providerKey
string

Action Response

data
object
successful
boolean
error

Retrieve a file for a given release.

Action Parameters

organization_id_or_slug
stringRequired
project_id_or_slug
stringRequired
version
stringRequired
file_id
stringRequired
download
boolean

Action Response

data
object
successful
boolean
error

List all members on a team. the response will not include members with pending invites.

Action Parameters

organization_id_or_slug
stringRequired
team_id_or_slug
stringRequired
cursor
string

Action Response

data
object
successful
boolean
error

Create a deploy.

Action Parameters

organization_id_or_slug
stringRequired
version
stringRequired
environment
stringRequired
url
string
name
string
projects
array
dateStarted
string
dateFinished
string

Action Response

data
object
successful
boolean
error

Retrieve a list of check-ins for a monitor

Action Parameters

organization_id_or_slug
stringRequired
monitor_id_or_slug
stringRequired

Action Response

data
object
successful
boolean
error

Returns details on a project’s ownership configuration.

Action Parameters

organization_id_or_slug
stringRequired
project_id_or_slug
stringRequired

Action Response

data
object
successful
boolean
error

Return a collection of replay recording segments.

Action Parameters

organization_id_or_slug
stringRequired
project_id_or_slug
stringRequired
replay_id
stringRequired
cursor
string
per_page
integer

Action Response

data
object
successful
boolean
error

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.

Action Parameters

organization_id_or_slug
stringRequired
action_id
integerRequired
trigger_type
stringRequired
service_type
stringRequired
integration_id
integer
target_identifier
string
target_display
string
projects
array

Action Response

data
object
successful
boolean
error

Organizationintegrationbaseendpoints expect both integration and organizationintegration db entries to exist for a given organization and integration id.

Action Parameters

organization_id_or_slug
stringRequired
integration_id
stringRequired

Action Response

data
object
successful
boolean
error

Return details on an individual organization, including various details such as membership access and teams.

Action Parameters

organization_id_or_slug
stringRequired
detailed
string

Action Response

data
object
successful
boolean
error

Return a list of projects bound to a organization.

Action Parameters

organization_id_or_slug
stringRequired
cursor
string

Action Response

data
object
successful
boolean
error

Lists all the available integrations for an organization.

Action Parameters

organization_id_or_slug
stringRequired
providerKey
string
features
array
includeConfig
boolean

Action Response

data
object
successful
boolean
error

Update an organization member’s attributes with a scim patch request.

Action Parameters

organization_id_or_slug
stringRequired
member_id
stringRequired
Operations
arrayRequired

Action Response

data
object
successful
boolean
error

Update a project release file.

Action Parameters

organization_id_or_slug
stringRequired
project_id_or_slug
stringRequired
version
stringRequired
file_id
stringRequired
name
string
dist
string

Action Response

data
object
successful
boolean
error

Schedules a team for deletion. note: deletion happens asynchronously and therefore is not immediate. teams will have their slug released while waiting for deletion.

Action Parameters

organization_id_or_slug
stringRequired
team_id_or_slug
stringRequired

Action Response

data
object
successful
boolean
error

Return a list of version control repositories for a given organization.

Action Parameters

organization_id_or_slug
stringRequired

Action Response

data
object
successful
boolean
error

Return details on an individual project.

Action Parameters

organization_id_or_slug
stringRequired
project_id_or_slug
stringRequired

Action Response

data
object
successful
boolean
error

Retrieve a list of check-ins for a monitor

Action Parameters

organization_id_or_slug
stringRequired
project_id_or_slug
stringRequired
monitor_id_or_slug
stringRequired

Action Response

data
object
successful
boolean
error

Return a list of projects bound to a team.

Action Parameters

organization_id_or_slug
stringRequired
team_id_or_slug
stringRequired
cursor
string

Action Response

data
object
successful
boolean
error

Delete an organization member with a scim user delete request.

Action Parameters

organization_id_or_slug
stringRequired
member_id
stringRequired

Action Response

data
object
successful
boolean
error

Delete a custom symbol source from a project.

Action Parameters

organization_id_or_slug
stringRequired
project_id_or_slug
stringRequired
id
stringRequired

Action Response

data
object
successful
boolean
error

Updates an individual issue’s attributes. only the attributes submitted are modified.

Action Parameters

organization_id_or_slug
stringRequired
issue_id
stringRequired
status
string
statusDetails__inNextRelease
boolean
statusDetails__inRelease
string
statusDetails__inCommit
string
assignedTo
string
hasSeen
boolean
isBookmarked
boolean
isSubscribed
boolean
isPublic
boolean

Action Response

data
object
successful
boolean
error

Link a user from an external provider to a sentry user.

Action Parameters

organization_id_or_slug
stringRequired
user_id
integerRequired
external_name
stringRequired
provider
stringRequired
integration_id
integerRequired
id
integerRequired
external_id
string

Action Response

data
object
successful
boolean
error

This resolves an event id to the project slug and internal issue id and internal event id.

Action Parameters

organization_id_or_slug
stringRequired
event_id
stringRequired

Action Response

data
object
successful
boolean
error

Delete an organization member from a team.

Action Parameters

organization_id_or_slug
stringRequired
member_id
stringRequired
team_id_or_slug
stringRequired

Action Response

data
object
successful
boolean
error

Retrieve a list of custom dashboards that are associated with the given organization.

Action Parameters

organization_id_or_slug
stringRequired
per_page
integer
cursor
string

Action Response

data
object
successful
boolean
error

Create a new saved query for the given organization.

Action Parameters

organization_id_or_slug
stringRequired
name
stringRequired
projects
array
queryDataset
stringDefaults to error-events
start
string
end
string
range
string
fields
array
orderby
string
environment
array
query
string
yAxis
array
display
string
topEvents
integer
interval
string

Action Response

data
object
successful
boolean
error

Add or invite a member to an organization.

Action Parameters

organization_id_or_slug
stringRequired
email
stringRequired
orgRole
stringDefaults to member
teamRoles
array
sendInvite
booleanDefaults to True
reinvite
boolean

Action Response

data
object
successful
boolean
error

Return details on an individual replay.

Action Parameters

organization_id_or_slug
stringRequired
replay_id
stringRequired
statsPeriod
string
start
string
end
string
field
array
project
array
environment
string
sort
string
query
string
per_page
integer
cursor
string

Action Response

data
object
successful
boolean
error

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).

Action Parameters

organization_id_or_slug
stringRequired
project_id_or_slug
stringRequired
event_id
stringRequired
name
stringRequired
email
stringRequired
comments
stringRequired

Action Response

data
object
successful
boolean
error

This resolves a short id to the project slug and internal issue id.

Action Parameters

organization_id_or_slug
stringRequired
short_id
stringRequired

Action Response

data
object
successful
boolean
error

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.

Action Parameters

organization_id_or_slug
stringRequired
member_id
stringRequired

Action Response

data
object
successful
boolean
error

Return a list of releases for a given organization.

Action Parameters

organization_id_or_slug
stringRequired
query
string

Action Response

data
object
successful
boolean
error

Organizationintegrationbaseendpoints expect both integration and organizationintegration db entries to exist for a given organization and integration id.

Action Parameters

organization_id_or_slug
stringRequired
integration_id
stringRequired

Action Response

data
object
successful
boolean
error

Retrieve a list of filters for a given project. active will be either a boolean or a list for the legacy browser filters.

Action Parameters

organization_id_or_slug
stringRequired
project_id_or_slug
stringRequired

Action Response

data
object
successful
boolean
error

Update a user in an external provider that is currently linked to a sentry user.

Action Parameters

organization_id_or_slug
stringRequired
external_user_id
integerRequired
user_id
integerRequired
external_name
stringRequired
provider
stringRequired
integration_id
integerRequired
id
integerRequired
external_id
string

Action Response

data
object
successful
boolean
error

Update various settings for a client key.

Action Parameters

organization_id_or_slug
stringRequired
project_id_or_slug
stringRequired
key_id
stringRequired
name
string
isActive
boolean
rateLimit__count
integer
rateLimit__window
integer
browserSdkVersion
string
dynamicSdkLoaderOptions__hasReplay
boolean
dynamicSdkLoaderOptions__hasPerformance
boolean
dynamicSdkLoaderOptions__hasDebug
boolean

Action Response

data
object
successful
boolean
error

Delete an external issue.

Action Parameters

uuid
stringRequired
external_issue_id
stringRequired

Action Response

data
object
successful
boolean
error

Create a new project bound to a team.

Action Parameters

organization_id_or_slug
stringRequired
team_id_or_slug
stringRequired
name
stringRequired
slug
string
platform
string
default_rules
boolean

Action Response

data
object
successful
boolean
error

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.

Action Parameters

owner
boolean
cursor
string
query
string
sortBy
string

Action Response

data
object
successful
boolean
error

Query an individual team with a scim group get request. - note that the members field will only contain up to 10000 members.

Action Parameters

team_id
integerRequired
organization_id_or_slug
stringRequired

Action Response

data
object
successful
boolean
error

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.

Action Parameters

organization_id_or_slug
stringRequired
member_id
stringRequired

Action Response

data
object
successful
boolean
error

Update the visibility for a project environment.

Action Parameters

organization_id_or_slug
stringRequired
project_id_or_slug
stringRequired
environment
stringRequired
isHidden
booleanRequired

Action Response

data
object
successful
boolean
error

Removes an individual issue.

Action Parameters

organization_id_or_slug
stringRequired
issue_id
stringRequired

Action Response

data
object
successful
boolean
error

Returns a list of emails. primary email will have isprimary: true

Action Parameters

user_id
stringRequired

Action Response

data
object
successful
boolean
error

Delete a saved query.

Action Parameters

organization_id_or_slug
stringRequired
query_id
integerRequired

Action Response

data
object
successful
boolean
error

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.

Action Parameters

organization_id_or_slug
stringRequired
startIndex
integerDefaults to 1
count
integerDefaults to 100
filter
string
excludedAttributes
array

Action Response

data
object
successful
boolean
error

Delete a team with a scim group delete request.

Action Parameters

organization_id_or_slug
stringRequired
team_id
integerRequired

Action Response

data
object
successful
boolean
error

Lists an organization’s environments.

Action Parameters

organization_id_or_slug
stringRequired
visibility
string

Action Response

data
object
successful
boolean
error

Retrieve a list of debug information files for a given project.

Action Parameters

organization_id_or_slug
stringRequired
project_id_or_slug
stringRequired

Action Response

data
object
successful
boolean
error

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.

Action Parameters

organization_id_or_slug
stringRequired
alert_rule_id
integerRequired

Action Response

data
object
successful
boolean
error

Update various attributes and configurable settings for the given project. note that solely having the project:read scope restricts updatable settings to isbookmarked.

Action Parameters

organization_id_or_slug
stringRequired
project_id_or_slug
stringRequired
isBookmarked
boolean
name
string
slug
string
platform
string
subjectPrefix
string
subjectTemplate
string
resolveAge
integer
highlightContext
object
highlightTags
array

Action Response

data
object
successful
boolean
error

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.

Action Parameters

organization_id_or_slug
stringRequired
project_id_or_slug
stringRequired
url
stringRequired
events
arrayRequired

Action Response

data
object
successful
boolean
error

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.

Action Parameters

organization_id_or_slug
stringRequired
field
stringRequired
statsPeriod
string
interval
string
start
string
end
string
project
array
category
string
outcome
string
reason
string
download
boolean

Action Response

data
object
successful
boolean
error

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.

Action Parameters

organization_id_or_slug
stringRequired
displayName
stringRequired

Action Response

data
object
successful
boolean
error

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.

Action Parameters

organization_id_or_slug
stringRequired
project
array
project_id_or_slug
array
triggerType
string

Action Response

data
object
successful
boolean
error

Delete an organization’s custom dashboard, or tombstone a pre-built dashboard which effectively deletes it.

Action Parameters

organization_id_or_slug
stringRequired
dashboard_id
integerRequired

Action Response

data
object
successful
boolean
error

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.

Action Parameters

organization_id_or_slug
stringRequired
project_id_or_slug
stringRequired
name
stringRequired
frequency
integerRequired
actionMatch
stringRequired
conditions
arrayRequired
actions
arrayRequired
environment
string
owner
string
filterMatch
string
filters
array

Action Response

data
object
successful
boolean
error

Return a list of users seen within this project.

Action Parameters

organization_id_or_slug
stringRequired
project_id_or_slug
stringRequired
query
string

Action Response

data
object
successful
boolean
error

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.

Action Parameters

organization_id_or_slug
stringRequired
trigger_type
stringRequired
service_type
stringRequired
integration_id
integer
target_identifier
string
target_display
string
projects
array

Action Response

data
object
successful
boolean
error