StackRox ComplianceManagementService API

openapi: 3.0.0
info:
  title: API Reference AlertService ComplianceManagementService 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: ComplianceManagementService
paths:
  /v1/complianceManagement/runs:
    get:
      operationId: GetRecentRuns
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v1GetRecentComplianceRunsResponse'
      parameters:
      - name: clusterId
        in: query
        required: false
        schema:
          type: string
      - name: standardId
        in: query
        required: false
        schema:
          type: string
      - name: since
        in: query
        required: false
        schema:
          type: string
          format: date-time
      tags:
      - ComplianceManagementService
  /v1/compliancemanagement/runs:
    post:
      operationId: TriggerRuns
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v1TriggerComplianceRunsResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/v1TriggerComplianceRunsRequest'
        required: true
      tags:
      - ComplianceManagementService
  /v1/compliancemanagement/runstatuses:
    get:
      operationId: GetRunStatuses
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v1GetComplianceRunStatusesResponse'
      parameters:
      - name: runIds
        in: query
        required: false
        explode: true
        schema:
          type: array
          items:
            type: string
      tags:
      - ComplianceManagementService
components:
  schemas:
    v1GetComplianceRunStatusesResponse:
      type: object
      properties:
        invalidRunIds:
          type: array
          items:
            type: string
        runs:
          type: array
          items:
            $ref: '#/components/schemas/v1ComplianceRun'
    v1ComplianceRunState:
      type: string
      enum:
      - INVALID
      - READY
      - STARTED
      - WAIT_FOR_DATA
      - EVALUTING_CHECKS
      - FINISHED
      default: INVALID
    v1ComplianceRunSelection:
      type: object
      properties:
        clusterId:
          type: string
          description: The ID of the cluster. "*" means "all clusters".
        standardId:
          type: string
          description: The ID of the compliance standard. "*" means "all standards".
    v1TriggerComplianceRunsRequest:
      type: object
      properties:
        selection:
          $ref: '#/components/schemas/v1ComplianceRunSelection'
    v1ComplianceRun:
      type: object
      properties:
        id:
          type: string
        clusterId:
          type: string
        standardId:
          type: string
        scheduleId:
          type: string
        startTime:
          type: string
          format: date-time
        finishTime:
          type: string
          format: date-time
        state:
          $ref: '#/components/schemas/v1ComplianceRunState'
        errorMessage:
          type: string
    v1GetRecentComplianceRunsResponse:
      type: object
      properties:
        complianceRuns:
          type: array
          items:
            $ref: '#/components/schemas/v1ComplianceRun'
    v1TriggerComplianceRunsResponse:
      type: object
      properties:
        startedRuns:
          type: array
          items:
            $ref: '#/components/schemas/v1ComplianceRun'
  securitySchemes:
    ApiToken:
      type: apiKey
      in: header
      name: Authorization
      description: 'StackRox API token. Format: Bearer {token}'