openapi: 3.0.0
info:
  title: API Reference AlertService SensorUpgradeService API
  version: '1'
  description: API reference for the StackRox Kubernetes Security Platform (upstream of Red Hat Advanced Cluster Security). Provides risk analysis, visibility, runtime alerts, policy management, compliance checking, and vulnerability management for containerized workloads. Authentication uses API tokens generated via /v1/apitokens/generate and passed as Bearer tokens.
  contact:
    email: support@stackrox.com
    url: https://www.stackrox.io/
  license:
    name: All Rights Reserved
    url: https://www.stackrox.com/
servers:
- url: https://{central-host}
  description: StackRox Central API server
  variables:
    central-host:
      default: stackrox.localhost
      description: StackRox Central hostname or IP
security:
- ApiToken: []
tags:
- name: SensorUpgradeService
paths:
  /v1/sensorupgrades/cluster/{id}:
    post:
      operationId: TriggerSensorUpgrade
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v1Empty'
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      tags:
      - SensorUpgradeService
  /v1/sensorupgrades/config:
    get:
      operationId: GetSensorUpgradeConfig
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v1GetSensorUpgradeConfigResponse'
      tags:
      - SensorUpgradeService
    post:
      operationId: UpdateSensorUpgradeConfig
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v1Empty'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/v1UpdateSensorUpgradeConfigRequest'
        required: true
      tags:
      - SensorUpgradeService
components:
  schemas:
    v1UpdateSensorUpgradeConfigRequest:
      type: object
      properties:
        config:
          $ref: '#/components/schemas/storageSensorUpgradeConfig'
    v1Empty:
      type: object
    v1GetSensorUpgradeConfigResponse:
      type: object
      properties:
        config:
          $ref: '#/components/schemas/storageSensorUpgradeConfig'
    storageSensorUpgradeConfig:
      type: object
      properties:
        enableAutoUpgrade:
          type: boolean
          format: boolean
          description: Whether to automatically trigger upgrades for out-of-date sensors.
      description: SensorUpgradeConfig encapsulates configuration relevant to sensor auto-upgrades.
  securitySchemes:
    ApiToken:
      type: apiKey
      in: header
      name: Authorization
      description: 'StackRox API token. Format: Bearer {token}'