StackRox DebugService API

The DebugService API from StackRox — 1 operation(s) for debugservice.

OpenAPI Specification

stackrox-debugservice-api-openapi.yml Raw ↑
openapi: 3.0.0
info:
  title: API Reference AlertService DebugService 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: DebugService
paths:
  /v1/debug/loglevel:
    get:
      summary: Get the current logging level for StackRox services.
      operationId: GetLogLevel
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v1LogLevelResponse'
      parameters:
      - name: modules
        in: query
        required: false
        explode: true
        schema:
          type: array
          items:
            type: string
      tags:
      - DebugService
    patch:
      summary: Set logging level for StackRox services.
      operationId: SetLogLevel
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                properties: {}
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/v1LogLevelRequest'
        required: true
      tags:
      - DebugService
components:
  schemas:
    v1LogLevelRequest:
      type: object
      properties:
        level:
          type: string
        modules:
          type: array
          items:
            type: string
    v1ModuleLevel:
      type: object
      properties:
        module:
          type: string
        level:
          type: string
    v1LogLevelResponse:
      type: object
      properties:
        level:
          type: string
        moduleLevels:
          type: array
          items:
            $ref: '#/components/schemas/v1ModuleLevel'
  securitySchemes:
    ApiToken:
      type: apiKey
      in: header
      name: Authorization
      description: 'StackRox API token. Format: Bearer {token}'