StackRox ProcessWhitelistService API

openapi: 3.0.0
info:
  title: API Reference AlertService ProcessWhitelistService 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: ProcessWhitelistService
paths:
  /v1/processwhitelists:
    put:
      summary: AddToProcessWhitelists adds a list of process names to each of a list of process whitelists
      operationId: UpdateProcessWhitelists
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v1UpdateProcessWhitelistsResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/v1UpdateProcessWhitelistsRequest'
        required: true
      tags:
      - ProcessWhitelistService
  /v1/processwhitelists/key:
    get:
      summary: GetProcessWhitelistById returns the single process whitelist referenced by the given ID.
      operationId: GetProcessWhitelist
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/storageProcessWhitelist'
      parameters:
      - name: key.deploymentId
        description: 'The idea is for the keys to be flexible.

          Only certain combinations of these will be supported.'
        in: query
        required: false
        schema:
          type: string
      - name: key.containerName
        in: query
        required: false
        schema:
          type: string
      - name: key.clusterId
        in: query
        required: false
        schema:
          type: string
      - name: key.namespace
        in: query
        required: false
        schema:
          type: string
      tags:
      - ProcessWhitelistService
  /v1/processwhitelists/lock:
    put:
      summary: LockProcessWhitelists accepts a list of whitelist IDs, locks those whitelists, and returns the updated whitelist objects
      operationId: LockProcessWhitelists
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v1UpdateProcessWhitelistsResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/v1LockProcessWhitelistsRequest'
        required: true
      tags:
      - ProcessWhitelistService
components:
  schemas:
    storageWhitelistElement:
      type: object
      properties:
        element:
          $ref: '#/components/schemas/storageWhitelistItem'
        auto:
          type: boolean
          format: boolean
    storageProcessWhitelist:
      type: object
      properties:
        id:
          type: string
        key:
          $ref: '#/components/schemas/storageProcessWhitelistKey'
        elements:
          type: array
          items:
            $ref: '#/components/schemas/storageWhitelistElement'
        elementGraveyard:
          type: array
          items:
            $ref: '#/components/schemas/storageWhitelistElement'
        created:
          type: string
          format: date-time
        userLockedTimestamp:
          type: string
          format: date-time
        stackRoxLockedTimestamp:
          type: string
          format: date-time
        lastUpdate:
          type: string
          format: date-time
    storageProcessWhitelistKey:
      type: object
      properties:
        deploymentId:
          type: string
          description: 'The idea is for the keys to be flexible.

            Only certain combinations of these will be supported.'
        containerName:
          type: string
        clusterId:
          type: string
        namespace:
          type: string
    v1ProcessWhitelistUpdateError:
      type: object
      properties:
        error:
          type: string
        key:
          $ref: '#/components/schemas/storageProcessWhitelistKey'
    v1LockProcessWhitelistsRequest:
      type: object
      properties:
        keys:
          type: array
          items:
            $ref: '#/components/schemas/storageProcessWhitelistKey'
        locked:
          type: boolean
          format: boolean
    storageWhitelistItem:
      type: object
      properties:
        processName:
          type: string
    v1UpdateProcessWhitelistsResponse:
      type: object
      properties:
        whitelists:
          type: array
          items:
            $ref: '#/components/schemas/storageProcessWhitelist'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/v1ProcessWhitelistUpdateError'
    v1UpdateProcessWhitelistsRequest:
      type: object
      properties:
        keys:
          type: array
          items:
            $ref: '#/components/schemas/storageProcessWhitelistKey'
        addElements:
          type: array
          items:
            $ref: '#/components/schemas/storageWhitelistItem'
        removeElements:
          type: array
          items:
            $ref: '#/components/schemas/storageWhitelistItem'
  securitySchemes:
    ApiToken:
      type: apiKey
      in: header
      name: Authorization
      description: 'StackRox API token. Format: Bearer {token}'