Sentry

Sentry Spike Protection API

Manage spike protection notification actions

Documentation GitHub OpenAPI

Documentation

https://docs.sentry.io/api/

https://docs.sentry.io/api/auth/

https://docs.sentry.io/api/guides/create-auth-token/

https://docs.sentry.io/api/ratelimits/

https://docs.sentry.io/api/events/

https://docs.sentry.io/api/organizations/

https://docs.sentry.io/api/projects/

https://docs.sentry.io/api/teams/

https://docs.sentry.io/api/releases/

https://docs.sentry.io/api/alerts/

https://docs.sentry.io/api/crons/

https://docs.sentry.io/api/dashboards/

https://docs.sentry.io/api/discover/

https://docs.sentry.io/api/environments/

https://docs.sentry.io/api/explore/

https://docs.sentry.io/api/integration/

https://docs.sentry.io/api/integrations/

https://docs.sentry.io/api/mobile-builds/

https://docs.sentry.io/api/monitors/

https://docs.sentry.io/api/prevent/

https://docs.sentry.io/api/replays/

https://docs.sentry.io/api/scim/

https://docs.sentry.io/api/seer/

https://docs.sentry.io/api/users/

Specifications

https://raw.githubusercontent.com/api-evangelist/sentry-system/refs/heads/main/openapi/sentry-system-spike-protection-api-openapi.yml

Schemas & Data

https://raw.githubusercontent.com/api-evangelist/sentry-system/refs/heads/main/json-schema/sentry-organization-schema.json

https://raw.githubusercontent.com/api-evangelist/sentry-system/refs/heads/main/json-schema/sentry-project-schema.json

https://raw.githubusercontent.com/api-evangelist/sentry-system/refs/heads/main/json-schema/sentry-issue-schema.json

https://raw.githubusercontent.com/api-evangelist/sentry-system/refs/heads/main/json-schema/sentry-event-schema.json

https://raw.githubusercontent.com/api-evangelist/sentry-system/refs/heads/main/json-schema/sentry-team-schema.json

https://raw.githubusercontent.com/api-evangelist/sentry-system/refs/heads/main/json-schema/sentry-release-schema.json

https://raw.githubusercontent.com/api-evangelist/sentry-system/refs/heads/main/json-schema/sentry-alert-rule-schema.json

https://raw.githubusercontent.com/api-evangelist/sentry-system/refs/heads/main/json-schema/sentry-monitor-schema.json

https://raw.githubusercontent.com/api-evangelist/sentry-system/refs/heads/main/json-schema/sentry-replay-schema.json

Other Resources

https://docs.sentry.io/platforms/

PostmanCollection

https://www.postman.com/sentryio/sentry-api-collection/documentation/xtzhckg/sentry-api-collection

https://docs.sentry.io/organization/integrations/integration-platform/webhooks/

https://docs.sentry.io/api/pagination/

https://docs.sentry.io/api/permissions/

https://docs.sentry.io/api/requests/

https://raw.githubusercontent.com/api-evangelist/sentry-system/refs/heads/main/json-ld/sentry-context.jsonld

OpenAPI Specification

openapi: 3.1.0
info:
  title: Sentry Alerts Spike Protection API
  description: The Alerts API provides endpoints for managing alert rules in Sentry, including creating, retrieving, updating, and deleting metric alert rules and issue alert rules, as well as managing spike protection notification actions.
  version: 0.0.1
  contact:
    name: Sentry Support
    url: https://sentry.io/support/
    email: support@sentry.io
servers:
- url: https://sentry.io/api/0
  description: Sentry Production API
security:
- BearerAuth: []
tags:
- name: Spike Protection
  description: Manage spike protection notification actions
paths:
  /organizations/{organization_id_or_slug}/spike-protections/:
    get:
      operationId: listSpikeProtectionNotifications
      summary: Sentry List spike protection notifications
      description: Returns a list of spike protection notification actions.
      tags:
      - Spike Protection
      parameters:
      - $ref: '#/components/parameters/OrganizationIdOrSlug'
      responses:
        '200':
          description: A list of spike protection notification actions.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SpikeProtectionAction'
        '401':
          description: Unauthorized.
        '403':
          description: Forbidden.
    post:
      operationId: createSpikeProtectionNotification
      summary: Sentry Create a spike protection notification action
      description: Creates a new spike protection notification action.
      tags:
      - Spike Protection
      parameters:
      - $ref: '#/components/parameters/OrganizationIdOrSlug'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - projects
              properties:
                projects:
                  type: array
                  items:
                    type: string
                  description: Project slugs to enable spike protection for.
      responses:
        '201':
          description: Spike protection notification created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SpikeProtectionAction'
        '400':
          description: Bad request.
        '401':
          description: Unauthorized.
components:
  parameters:
    OrganizationIdOrSlug:
      name: organization_id_or_slug
      in: path
      required: true
      description: The ID or slug of the organization.
      schema:
        type: string
  schemas:
    SpikeProtectionAction:
      type: object
      properties:
        id:
          type: string
        projects:
          type: array
          items:
            type: string
        dateCreated:
          type: string
          format: date-time
      required:
      - id
      - projects
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: Authentication token for the Sentry API.