Feeling bold?
Sentry's Docs BotAsk A Bot
Product
API
Changelog
Sandbox
Sign In

Retrieve an Issue Alert Rule for a Project

GET /api/0/projects/{organization_slug}/{project_slug}/rules/{rule_id}/

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.

Path Parameters

organization_slug (string)
REQUIRED

The slug of the organization the resource belongs to.

project_slug (string)
REQUIRED

The slug of the project the resource belongs to.

rule_id (integer)
REQUIRED

The ID of the rule you'd like to query.

Scopes

<auth_token> requires one of the following scopes:
  • alerts:read
  • alerts:write
  • project:admin
  • project:read
  • project:write
curl https://sentry.io/api/0/projects/{organization_slug}/{project_slug}/rules/{rule_id}/ \
 -H 'Authorization: Bearer <auth_token>'
RESPONSESCHEMA
{
  "id": "7",
  "conditions": [
    {
      "id": "sentry.rules.conditions.regression_event.RegressionEventCondition"
    }
  ],
  "filters": [
    {
      "id": "sentry.rules.filters.age_comparison.AgeComparisonFilter",
      "comparison_type": "older",
      "value": 4,
      "time": "week"
    },
    {
      "id": "sentry.rules.filters.issue_occurrences.IssueOccurrencesFilter",
      "value": 1000
    }
  ],
  "actions": [
    {
      "id": "sentry.integrations.slack.notify_action.SlackNotifyServiceAction",
      "workspace": 976462356,
      "channel": "#fatal",
      "tags": "browser,release"
    }
  ],
  "actionMatch": "all",
  "filterMatch": "all",
  "frequency": 60,
  "name": "Many Old Regressions!",
  "dateCreated": "2023-02-17T18:31:14.246012Z",
  "owner": "user:635623",
  "createdBy": {
    "id": 635623,
    "name": "John Doe",
    "email": "john.doe@email.com"
  },
  "environment": null,
  "projects": [
    "javascript"
  ],
  "status": "active",
  "snooze": false
}