openapi: 3.0.3
info:
  title: Stellar Cyber Open XDR Alerts Sensors API
  description: The Stellar Cyber REST API provides programmatic access to the Open XDR platform, enabling automation of security operations including case management, tenant administration, connector management, alert handling, query operations, user management, watchlists, sensors, and security event management.
  version: '6.3'
  contact:
    name: Stellar Cyber Support
    url: https://stellarcyber.zendesk.com
  license:
    name: Proprietary
    url: https://stellarcyber.ai/terms/
servers:
- url: https://{platformHostname}/connect/api/v1
  description: Stellar Cyber Platform API
  variables:
    platformHostname:
      description: Your Stellar Cyber platform hostname
      default: your-platform.stellarcyber.ai
security:
- bearerAuth: []
tags:
- name: Sensors
  description: Sensor monitoring and management
paths:
  /sensors:
    get:
      operationId: listSensors
      summary: List Sensors
      description: Retrieve all sensors registered with the platform.
      tags:
      - Sensors
      responses:
        '200':
          description: List of sensors
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SensorsListResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /sensors/{sensorId}:
    get:
      operationId: getSensor
      summary: Get Sensor
      description: Retrieve information about a specific sensor.
      tags:
      - Sensors
      parameters:
      - $ref: '#/components/parameters/SensorId'
      responses:
        '200':
          description: Sensor details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Sensor'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
    delete:
      operationId: deleteSensor
      summary: Delete Sensor
      description: Delete a sensor from the platform.
      tags:
      - Sensors
      parameters:
      - $ref: '#/components/parameters/SensorId'
      responses:
        '204':
          description: Sensor deleted successfully
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  schemas:
    Sensor:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        type:
          type: string
        status:
          type: string
          enum:
          - online
          - offline
          - error
        ip_address:
          type: string
        version:
          type: string
        last_seen:
          type: string
          format: date-time
    SensorsListResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Sensor'
        total:
          type: integer
    Error:
      type: object
      properties:
        error:
          type: string
        message:
          type: string
        code:
          type: integer
  responses:
    Unauthorized:
      description: Authentication required or token expired
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  parameters:
    SensorId:
      name: sensorId
      in: path
      required: true
      description: Unique identifier for the sensor
      schema:
        type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: JWT token obtained from /access_token endpoint. Tokens expire after 10 minutes. API keys can also be used as Bearer tokens for the /access_token call.