v1

latestOpenAPI 3.0.3Apache 2.02026-07-142201861.5 MB
Spike Protection

List Spike Protection Notifications

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 the project query parameter with project IDs or slugs to filter for certain projects. A legacy project slug query parameter is also supported and takes priority if both are present.

get/api/0/organizations/{organization_id_or_slug}/notifications/actions/

Path parameters

organization_id_or_slugstring required

The ID or slug of the organization the resource belongs to.

Query parameters

The IDs or slugs of projects to filter by. Project slugs are unique within each organization. Omit this parameter to include all accessible projects. -1 is also accepted to include all accessible projects. For example, the following are valid parameters:

  • /?project=1234&project=56789
  • /?project=android&project=javascript-react
  • /?project=-1
project_id_or_slugstring[]

The legacy project slug filter. Prefer project, which accepts project IDs or slugs. Use $all to include all available projects. For example, the following are valid parameters:

  • /?projectSlug=$all
  • /?projectSlug=android&projectSlug=javascript-react
triggerTypestring

Type of the trigger that causes the notification. The only supported value right now is: spike-protection

Response

idinteger required
organizationIdinteger required
integrationIdinteger nullable required
sentryAppIdinteger nullable required
projectsinteger[] required
serviceTypestring nullable required
triggerTypestring required
targetTypestring nullable required
targetIdentifierstring nullable required
targetDisplaystring nullable required