Stream.Security

Stream.Security Notifications API

The Notifications API from Stream.Security — 2 operation(s) for notifications.

GitHub OpenAPI

Operations 5

POST /notifications Create Notification Rule #
GET /notifications List Notification Rules #
DELETE /notifications/{id} Delete Notification Rule #
GET /notifications/{id} Get Notification Rule #
PATCH /notifications/{id} Update Notification Rule #

Documentation

📖
Documentation
https://docs.streamsec.io/
📖
APIReference
https://docs.streamsec.io/reference
📖
GettingStarted
https://docs.streamsec.io/reference/getting-started-with-stream-api
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/stream-security/refs/heads/main/authentication/stream-security-authentication.yml
📖
RateLimits
https://raw.githubusercontent.com/api-evangelist/stream-security/refs/heads/main/rate-limits/stream-security-rate-limits.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/stream-security/refs/heads/main/openapi/stream-security-notifications-api-openapi.yml

Other Resources

🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/stream-security/refs/heads/main/errors/stream-security-problem-types.yml
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/stream-security/refs/heads/main/conventions/stream-security-conventions.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/stream-security/refs/heads/main/data-model/stream-security-data-model.yml
🔗
Webhooks
https://raw.githubusercontent.com/api-evangelist/stream-security/refs/heads/main/asyncapi/stream-security-notifications-webhooks.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/stream-security-notifications-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

stream-security-notifications-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Stream Security Notifications API
  description: Stream Security API for managing security rules, integrations, AI interactions, and more.
  version: 1.0.0
servers:
- url: https://{app}.streamsec.io/openapi
tags:
- name: Notifications
paths:
  /notifications:
    post:
      operationId: notifications-create
      summary: Create Notification Rule
      description: 'Creates a new notification rule with the specified configuration.


        The rule will trigger alerts to configured destinations when matching events occur.'
      tags:
      - Notifications
      security:
      - BearerAuth: []
      parameters:
      - in: header
        name: workspace
        schema:
          description: Workspace ID
          type: string
        description: Workspace ID
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  minLength: 1
                  maxLength: 100
                description:
                  type: string
                  maxLength: 250
                enabled:
                  default: true
                  type: boolean
                event_type:
                  type: string
                  enum:
                  - cloud_event
                  - detection
                  - simulation_event
                channels:
                  type: array
                  items:
                    type: object
                    properties:
                      type:
                        anyOf:
                        - type: string
                          enum:
                          - webhook
                          - splunk
                          - pagerduty
                          - microsoftteams
                          - opsgenie
                          - logzio
                          - googlecards
                          - paloaltocortexxsiam
                          - torq
                        - type: string
                          const: slack
                      subtype:
                        anyOf:
                        - type: string
                          enum:
                          - webhook
                          - splunk
                          - pagerduty
                          - microsoftteams
                          - opsgenie
                          - logzio
                          - googlecards
                          - paloaltocortexxsiam
                          - torq
                        - type: string
                          const: slack
                      id:
                        type: string
                    required:
                    - type
                    - id
                condition:
                  type: object
                  properties:
                    main_filter:
                      type: object
                      properties:
                        operand:
                          type: string
                          enum:
                          - and
                          - or
                        filters:
                          type: array
                          items:
                            type: object
                            properties:
                              field:
                                type: string
                              match_type:
                                type: string
                                enum:
                                - is
                                - is_not
                                - contains
                                - not_contains
                                - regex
                                - gte
                                - lte
                                - exists
                                - not_exists
                                - empty
                                - not_empty
                              value: {}
                              tag:
                                type: object
                                properties:
                                  key:
                                    type: string
                                  match_type:
                                    type: string
                                    enum:
                                    - is
                                    - is_not
                                    - contains
                                    - not_contains
                                    - empty
                                    - not_empty
                                    - regex
                                  value:
                                    type: string
                              operand:
                                type: string
                                enum:
                                - and
                                - or
                              filters:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    field:
                                      type: string
                                    match_type:
                                      type: string
                                      enum:
                                      - is
                                      - is_not
                                      - contains
                                      - not_contains
                                      - regex
                                      - gte
                                      - lte
                                      - exists
                                      - not_exists
                                      - empty
                                      - not_empty
                                    value: {}
                                    tag:
                                      type: object
                                      properties:
                                        key:
                                          type: string
                                        match_type:
                                          type: string
                                          enum:
                                          - is
                                          - is_not
                                          - contains
                                          - not_contains
                                          - empty
                                          - not_empty
                                          - regex
                                        value:
                                          type: string
                      required:
                      - operand
              required:
              - name
              - event_type
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                  name:
                    type: string
                  description:
                    anyOf:
                    - type: string
                    - type: 'null'
                  enabled:
                    type: boolean
                  event_type:
                    type: string
                    enum:
                    - cloud_event
                    - detection
                    - simulation_event
                  channels:
                    anyOf:
                    - type: array
                      items:
                        type: object
                        properties:
                          type:
                            anyOf:
                            - type: string
                              enum:
                              - webhook
                              - splunk
                              - pagerduty
                              - microsoftteams
                              - opsgenie
                              - logzio
                              - googlecards
                              - paloaltocortexxsiam
                              - torq
                            - type: string
                              const: slack
                          subtype:
                            anyOf:
                            - type: string
                              enum:
                              - webhook
                              - splunk
                              - pagerduty
                              - microsoftteams
                              - opsgenie
                              - logzio
                              - googlecards
                              - paloaltocortexxsiam
                              - torq
                            - type: string
                              const: slack
                          id:
                            type: string
                        required:
                        - type
                        - id
                        additionalProperties: false
                    - type: 'null'
                  condition:
                    anyOf:
                    - type: object
                      properties:
                        main_filter:
                          type: object
                          properties:
                            operand:
                              type: string
                              enum:
                              - and
                              - or
                            filters:
                              type: array
                              items:
                                type: object
                                properties:
                                  field:
                                    type: string
                                  match_type:
                                    type: string
                                    enum:
                                    - is
                                    - is_not
                                    - contains
                                    - not_contains
                                    - regex
                                    - gte
                                    - lte
                                    - exists
                                    - not_exists
                                    - empty
                                    - not_empty
                                  value: {}
                                  tag:
                                    type: object
                                    properties:
                                      key:
                                        type: string
                                      match_type:
                                        type: string
                                        enum:
                                        - is
                                        - is_not
                                        - contains
                                        - not_contains
                                        - empty
                                        - not_empty
                                        - regex
                                      value:
                                        type: string
                                    additionalProperties: false
                                  operand:
                                    type: string
                                    enum:
                                    - and
                                    - or
                                  filters:
                                    type: array
                                    items:
                                      type: object
                                      properties:
                                        field:
                                          type: string
                                        match_type:
                                          type: string
                                          enum:
                                          - is
                                          - is_not
                                          - contains
                                          - not_contains
                                          - regex
                                          - gte
                                          - lte
                                          - exists
                                          - not_exists
                                          - empty
                                          - not_empty
                                        value: {}
                                        tag:
                                          type: object
                                          properties:
                                            key:
                                              type: string
                                            match_type:
                                              type: string
                                              enum:
                                              - is
                                              - is_not
                                              - contains
                                              - not_contains
                                              - empty
                                              - not_empty
                                              - regex
                                            value:
                                              type: string
                                          additionalProperties: false
                                      additionalProperties: false
                                additionalProperties: false
                          required:
                          - operand
                          additionalProperties: false
                      additionalProperties: false
                    - type: 'null'
                  created_by:
                    anyOf:
                    - type: string
                    - type: 'null'
                  created_at:
                    anyOf:
                    - type: string
                    - type: 'null'
                  modified_at:
                    anyOf:
                    - type: string
                    - type: 'null'
                required:
                - id
                - name
                - enabled
                - event_type
                additionalProperties: false
        '400':
          description: Invalid input data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.BAD_REQUEST'
        '401':
          description: Authorization not provided
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.UNAUTHORIZED'
        '403':
          description: Insufficient access
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.FORBIDDEN'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.INTERNAL_SERVER_ERROR'
    get:
      operationId: notifications-list
      summary: List Notification Rules
      description: 'Retrieves notification rules with optional filtering and pagination.


        Notification rules define when and how users are notified about security events.


        Results are returned in descending order by creation date.'
      tags:
      - Notifications
      security:
      - BearerAuth: []
      parameters:
      - in: header
        name: workspace
        schema:
          description: Workspace ID
          type: string
        description: Workspace ID
      - in: query
        name: event_types
        schema:
          type: array
          items:
            type: string
            enum:
            - cloud_event
            - detection
            - simulation_event
      - in: query
        name: statuses
        schema:
          type: array
          items:
            type: string
            enum:
            - active
            - inactive
      - in: query
        name: destinations
        schema:
          type: array
          items:
            type: string
      - in: query
        name: severities
        schema:
          type: array
          items:
            type: string
            enum:
            - low
            - medium
            - high
            - critical
      - in: query
        name: search
        schema:
          type: string
      - in: query
        name: limit
        schema:
          default: 10
          type: number
          minimum: 1
          maximum: 100
      - in: query
        name: cursor
        schema:
          type: number
          minimum: 0
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        name:
                          type: string
                        description:
                          anyOf:
                          - type: string
                          - type: 'null'
                        enabled:
                          type: boolean
                        event_type:
                          type: string
                          enum:
                          - cloud_event
                          - detection
                          - simulation_event
                        channels:
                          anyOf:
                          - type: array
                            items:
                              type: object
                              properties:
                                type:
                                  anyOf:
                                  - type: string
                                    enum:
                                    - webhook
                                    - splunk
                                    - pagerduty
                                    - microsoftteams
                                    - opsgenie
                                    - logzio
                                    - googlecards
                                    - paloaltocortexxsiam
                                    - torq
                                  - type: string
                                    const: slack
                                subtype:
                                  anyOf:
                                  - type: string
                                    enum:
                                    - webhook
                                    - splunk
                                    - pagerduty
                                    - microsoftteams
                                    - opsgenie
                                    - logzio
                                    - googlecards
                                    - paloaltocortexxsiam
                                    - torq
                                  - type: string
                                    const: slack
                                id:
                                  type: string
                              required:
                              - type
                              - id
                              additionalProperties: false
                          - type: 'null'
                        condition:
                          anyOf:
                          - type: object
                            properties:
                              main_filter:
                                type: object
                                properties:
                                  operand:
                                    type: string
                                    enum:
                                    - and
                                    - or
                                  filters:
                                    type: array
                                    items:
                                      type: object
                                      properties:
                                        field:
                                          type: string
                                        match_type:
                                          type: string
                                          enum:
                                          - is
                                          - is_not
                                          - contains
                                          - not_contains
                                          - regex
                                          - gte
                                          - lte
                                          - exists
                                          - not_exists
                                          - empty
                                          - not_empty
                                        value: {}
                                        tag:
                                          type: object
                                          properties:
                                            key:
                                              type: string
                                            match_type:
                                              type: string
                                              enum:
                                              - is
                                              - is_not
                                              - contains
                                              - not_contains
                                              - empty
                                              - not_empty
                                              - regex
                                            value:
                                              type: string
                                          additionalProperties: false
                                        operand:
                                          type: string
                                          enum:
                                          - and
                                          - or
                                        filters:
                                          type: array
                                          items:
                                            type: object
                                            properties:
                                              field:
                                                type: string
                                              match_type:
                                                type: string
                                                enum:
                                                - is
                                                - is_not
                                                - contains
                                                - not_contains
                                                - regex
                                                - gte
                                                - lte
                                                - exists
                                                - not_exists
                                                - empty
                                                - not_empty
                                              value: {}
                                              tag:
                                                type: object
                                                properties:
                                                  key:
                                                    type: string
                                                  match_type:
                                                    type: string
                                                    enum:
                                                    - is
                                                    - is_not
                                                    - contains
                                                    - not_contains
                                                    - empty
                                                    - not_empty
                                                    - regex
                                                  value:
                                                    type: string
                                                additionalProperties: false
                                            additionalProperties: false
                                      additionalProperties: false
                                required:
                                - operand
                                additionalProperties: false
                            additionalProperties: false
                          - type: 'null'
                        created_by:
                          anyOf:
                          - type: string
                          - type: 'null'
                        created_at:
                          anyOf:
                          - type: string
                          - type: 'null'
                        modified_at:
                          anyOf:
                          - type: string
                          - type: 'null'
                        customer_id:
                          type: string
                      required:
                      - id
                      - name
                      - enabled
                      - event_type
                      additionalProperties: false
                  total:
                    type: number
                  totalUnfiltered:
                    type: number
                required:
                - items
                - total
                - totalUnfiltered
                additionalProperties: false
        '400':
          description: Invalid input data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.BAD_REQUEST'
        '401':
          description: Authorization not provided
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.UNAUTHORIZED'
        '403':
          description: Insufficient access
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.FORBIDDEN'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.NOT_FOUND'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.INTERNAL_SERVER_ERROR'
  /notifications/{id}:
    delete:
      operationId: notifications-delete
      summary: Delete Notification Rule
      description: 'Permanently deletes a notification rule.


        This action cannot be undone.'
      tags:
      - Notifications
      security:
      - BearerAuth: []
      parameters:
      - in: header
        name: workspace
        schema:
          description: Workspace ID
          type: string
        description: Workspace ID
      - in: path
        name: id
        schema:
          type: string
        required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                required:
                - success
                additionalProperties: false
        '400':
          description: Invalid input data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.BAD_REQUEST'
        '401':
          description: Authorization not provided
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.UNAUTHORIZED'
        '403':
          description: Insufficient access
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.FORBIDDEN'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.NOT_FOUND'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.INTERNAL_SERVER_ERROR'
    get:
      operationId: notifications-get
      summary: Get Notification Rule
      description: 'Retrieves a single notification rule by ID.


        Returns the complete notification configuration including channels, conditions, and settings.'
      tags:
      - Notifications
      security:
      - BearerAuth: []
      parameters:
      - in: header
        name: workspace
        schema:
          description: Workspace ID
          type: string
        description: Workspace ID
      - in: path
        name: id
        schema:
          type: string
        required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                  name:
                    type: string
                  description:
                    anyOf:
                    - type: string
                    - type: 'null'
                  enabled:
                    type: boolean
                  event_type:
                    type: string
                    enum:
                    - cloud_event
                    - detection
                    - simulation_event
                  channels:
                    anyOf:
                    - type: array
                      items:
                        type: object
                        properties:
                          type:
                            anyOf:
                            - type: string
                              enum:
                              - webhook
                              - splunk
                              - pagerduty
                              - microsoftteams
                              - opsgenie
                              - logzio
                              - googlecards
                              - paloaltocortexxsiam
                              - torq
                            - type: string
                              const: slack
                          subtype:
                            anyOf:
                            - type: string
                              enum:
                              - webhook
                              - splunk
                              - pagerduty
                              - microsoftteams
                              - opsgenie
                              - logzio
                              - googlecards
                              - paloaltocortexxsiam
                              - torq
                            - type: string
                              const: slack
                          id:
                            type: string
                        required:
                        - type
                        - id
                        additionalProperties: false
                    - type: 'null'
                  condition:
                    anyOf:
                    - type: object
                      properties:
     

# --- truncated at 32 KB (59 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/stream-security/refs/heads/main/openapi/stream-security-notifications-api-openapi.yml