StackRox ConfigService API

openapi: 3.0.0
info:
  title: API Reference AlertService ConfigService 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: ConfigService
paths:
  /v1/config:
    get:
      operationId: GetConfig
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/storageConfig'
      tags:
      - ConfigService
    put:
      operationId: PutConfig
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/storageConfig'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/v1PutConfigRequest'
        required: true
      tags:
      - ConfigService
  /v1/config/private:
    get:
      operationId: GetPrivateConfig
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/storagePrivateConfig'
      tags:
      - ConfigService
  /v1/config/public:
    get:
      operationId: GetPublicConfig
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/storagePublicConfig'
      tags:
      - ConfigService
components:
  schemas:
    storageBannerConfig:
      type: object
      properties:
        enabled:
          type: boolean
          format: boolean
        text:
          type: string
        size:
          $ref: '#/components/schemas/BannerConfigSize'
        color:
          type: string
        backgroundColor:
          type: string
    BannerConfigSize:
      type: string
      enum:
      - UNSET
      - SMALL
      - MEDIUM
      - LARGE
      default: UNSET
    storagePrivateConfig:
      type: object
      properties:
        DEPRECATEDAlertRetentionDurationDays:
          type: integer
          format: int32
          title: will be deprecated after migration is ready
        alertConfig:
          $ref: '#/components/schemas/storageAlertRetentionConfig'
        imageRetentionDurationDays:
          type: integer
          format: int32
      title: 'next available tag: 4'
    storageConfig:
      type: object
      properties:
        publicConfig:
          $ref: '#/components/schemas/storagePublicConfig'
        privateConfig:
          $ref: '#/components/schemas/storagePrivateConfig'
    v1PutConfigRequest:
      type: object
      properties:
        config:
          $ref: '#/components/schemas/storageConfig'
    storageAlertRetentionConfig:
      type: object
      properties:
        resolvedDeployRetentionDurationDays:
          type: integer
          format: int32
        deletedRuntimeRetentionDurationDays:
          type: integer
          format: int32
        allRuntimeRetentionDurationDays:
          type: integer
          format: int32
    storagePublicConfig:
      type: object
      properties:
        loginNotice:
          $ref: '#/components/schemas/storageLoginNotice'
        header:
          $ref: '#/components/schemas/storageBannerConfig'
        footer:
          $ref: '#/components/schemas/storageBannerConfig'
    storageLoginNotice:
      type: object
      properties:
        enabled:
          type: boolean
          format: boolean
        text:
          type: string
  securitySchemes:
    ApiToken:
      type: apiKey
      in: header
      name: Authorization
      description: 'StackRox API token. Format: Bearer {token}'