StackRox

StackRox ConfigService API

The ConfigService API from StackRox — 3 operation(s) for configservice.

Documentation GitHub OpenAPI

Operations 4

GET /v1/config #

PUT /v1/config #

GET /v1/config/private #

GET /v1/config/public #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/stackrox-configservice-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Reference AlertService Config Service 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
    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'
    storagePublicConfig:
      type: object
      properties:
        loginNotice:
          $ref: '#/components/schemas/storageLoginNotice'
        header:
          $ref: '#/components/schemas/storageBannerConfig'
        footer:
          $ref: '#/components/schemas/storageBannerConfig'
    storageAlertRetentionConfig:
      type: object
      properties:
        resolvedDeployRetentionDurationDays:
          type: integer
          format: int32
        deletedRuntimeRetentionDurationDays:
          type: integer
          format: int32
        allRuntimeRetentionDurationDays:
          type: integer
          format: int32
    storageLoginNotice:
      type: object
      properties:
        enabled:
          type: boolean
          format: boolean
        text:
          type: string
    BannerConfigSize:
      type: string
      enum:
      - UNSET
      - SMALL
      - MEDIUM
      - LARGE
      default: UNSET
    v1PutConfigRequest:
      type: object
      properties:
        config:
          $ref: '#/components/schemas/storageConfig'
  securitySchemes:
    ApiToken:
      type: apiKey
      in: header
      name: Authorization
      description: 'StackRox API token. Format: Bearer {token}'