Stream.Security

Stream.Security Canaries API

The Canaries API from Stream.Security — 1 operation(s) for canaries.

GitHub OpenAPI

Operations 1

GET /canaries Get Canaries #

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-canaries-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-canaries-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-canaries-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Stream Security Canaries 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: Canaries
paths:
  /canaries:
    get:
      operationId: canaries-list
      summary: Get Canaries
      description: 'Retrieves a list of all deployed and configured canary resources across monitored accounts.


        A canary resource is a controlled, decoy asset - such as an S3 bucket - used to detect unauthorized activity by triggering alerts when predefined detection actions occur.


        This endpoint supports filtering by account ID, region, resource type, status, creator, and other attributes. Optional parameters allow inclusion of related activity logs for each canary.


        Returned objects include canary metadata, deployment status, detection settings, exclusion rules, and recent activity indicators.'
      tags:
      - Canaries
      security:
      - BearerAuth: []
      parameters:
      - in: header
        name: workspace
        schema:
          description: Workspace ID
          type: string
        description: Workspace ID
      - in: query
        name: accountId
        schema:
          type: array
          items:
            type: string
      - in: query
        name: activityLogs
        schema:
          type: boolean
      - in: query
        name: createdBy
        schema:
          type: array
          items:
            type: string
      - in: query
        name: phrase
        schema:
          type: string
      - in: query
        name: region
        schema:
          type: array
          items:
            type: string
      - in: query
        name: resourceId
        schema:
          type: array
          items:
            type: string
      - in: query
        name: resourceType
        schema:
          type: array
          items:
            type: string
      - in: query
        name: status
        schema:
          type: array
          items:
            type: string
            enum:
            - active
            - disabled
            - not_deployed
            - deleted
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    _id:
                      type: string
                    name:
                      type: string
                    accountId:
                      type: string
                    subscriptionId:
                      type: string
                    resourceGroupId:
                      type: string
                    region:
                      type: string
                    resourceType:
                      type: string
                    description:
                      type: string
                    status:
                      type: string
                    createdBy:
                      type: string
                    createdAt:
                      type: string
                    attackPaths:
                      type: object
                      propertyNames:
                        type: string
                      additionalProperties:
                        type: number
                    detectionsCount:
                      type: number
                    isSandbox:
                      type: boolean
                    hasActivityLogs:
                      type: boolean
                    initialTags:
                      type: array
                      items:
                        type: object
                        properties:
                          key:
                            type: string
                          value:
                            type: string
                        required:
                        - key
                        - value
                        additionalProperties: false
                    excludeTags:
                      type: array
                      items:
                        type: object
                        properties:
                          _id:
                            type: string
                          key:
                            type: string
                          match_type:
                            type: string
                          value:
                            type: string
                        required:
                        - _id
                        - key
                        - match_type
                        - value
                        additionalProperties: false
                    resourceId:
                      type: string
                    iamRoles:
                      type: array
                      items:
                        type: string
                    allowProjectVmAccess:
                      type: boolean
                    detectionEnabled:
                      type: boolean
                    detectionActions:
                      type: array
                      items:
                        type: string
                    azureStorageAccountId:
                      type: string
                  required:
                  - _id
                  - name
                  - accountId
                  - region
                  - resourceType
                  - status
                  - createdAt
                  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'
components:
  schemas:
    error.UNAUTHORIZED:
      title: Authorization not provided error (401)
      description: The error information
      example:
        code: UNAUTHORIZED
        message: Authorization not provided
        issues: []
      type: object
      properties:
        message:
          description: The error message
          example: Authorization not provided
          type: string
        code:
          description: The error code
          example: UNAUTHORIZED
          type: string
        issues:
          description: An array of issues that were responsible for the error
          example: []
          type: array
          items:
            type: object
            properties:
              message:
                type: string
            required:
            - message
            additionalProperties: false
      required:
      - message
      - code
      additionalProperties: false
    error.INTERNAL_SERVER_ERROR:
      title: Internal server error error (500)
      description: The error information
      example:
        code: INTERNAL_SERVER_ERROR
        message: Internal server error
        issues: []
      type: object
      properties:
        message:
          description: The error message
          example: Internal server error
          type: string
        code:
          description: The error code
          example: INTERNAL_SERVER_ERROR
          type: string
        issues:
          description: An array of issues that were responsible for the error
          example: []
          type: array
          items:
            type: object
            properties:
              message:
                type: string
            required:
            - message
            additionalProperties: false
      required:
      - message
      - code
      additionalProperties: false
    error.BAD_REQUEST:
      title: Invalid input data error (400)
      description: The error information
      example:
        code: BAD_REQUEST
        message: Invalid input data
        issues: []
      type: object
      properties:
        message:
          description: The error message
          example: Invalid input data
          type: string
        code:
          description: The error code
          example: BAD_REQUEST
          type: string
        issues:
          description: An array of issues that were responsible for the error
          example: []
          type: array
          items:
            type: object
            properties:
              message:
                type: string
            required:
            - message
            additionalProperties: false
      required:
      - message
      - code
      additionalProperties: false
    error.NOT_FOUND:
      title: Not found error (404)
      description: The error information
      example:
        code: NOT_FOUND
        message: Not found
        issues: []
      type: object
      properties:
        message:
          description: The error message
          example: Not found
          type: string
        code:
          description: The error code
          example: NOT_FOUND
          type: string
        issues:
          description: An array of issues that were responsible for the error
          example: []
          type: array
          items:
            type: object
            properties:
              message:
                type: string
            required:
            - message
            additionalProperties: false
      required:
      - message
      - code
      additionalProperties: false
    error.FORBIDDEN:
      title: Insufficient access error (403)
      description: The error information
      example:
        code: FORBIDDEN
        message: Insufficient access
        issues: []
      type: object
      properties:
        message:
          description: The error message
          example: Insufficient access
          type: string
        code:
          description: The error code
          example: FORBIDDEN
          type: string
        issues:
          description: An array of issues that were responsible for the error
          example: []
          type: array
          items:
            type: object
            properties:
              message:
                type: string
            required:
            - message
            additionalProperties: false
      required:
      - message
      - code
      additionalProperties: false
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
x-apis-io-provenance:
  assembled: true
  date: '2026-08-29'
  method: searched
  note: 'NOT a single verbatim download. Stream.Security publishes its OpenAPI as PER-OPERATION fragments embedded in its ReadMe-hosted reference pages: each https://docs.streamsec.io/reference/<operationId>.md carries a ''# OpenAPI definition'' block containing a complete OpenAPI 3.1.0 document for that one operation. 44 reference pages were fetched (all HTTP 200) on 2026-08-29; 34 contained an OpenAPI fragment and were merged on paths and components. Every path, operation, parameter, schema and response below is the provider''s own published text, unmodified. Only the union is ours. The consolidated spec is not downloadable from ReadMe as one file - /openapi.json, /openapi.yaml and the /branches/1.0/apis/*.json paths return 404 or 429.'
  sources:
  - https://docs.streamsec.io/reference/
  - https://docs.streamsec.io/llms.txt
  fragments_merged: 34
  ownership_check: Confirmed. info.title 'Stream Security API'; servers[] https://{app}.streamsec.io/openapi. streamsec.io is Stream.Security's own operational domain - app.streamsec.io is the product console named as 'YOUR STREAM SECURITY DOMAIN URL' in the provider's MCP setup docs, and docs.streamsec.io is the documentation host. The streamsec.io domain, rather than stream.security, is the pre-rename Lightlytics-era infrastructure the company still runs its product on.