StackRox NamespaceService API

openapi: 3.0.0
info:
  title: API Reference AlertService NamespaceService 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: NamespaceService
paths:
  /v1/namespaces:
    get:
      operationId: GetNamespaces
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v1GetNamespacesResponse'
      tags:
      - NamespaceService
  /v1/namespaces/{id}:
    get:
      operationId: GetNamespace
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v1Namespace'
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      tags:
      - NamespaceService
components:
  schemas:
    v1GetNamespacesResponse:
      type: object
      properties:
        namespaces:
          type: array
          items:
            $ref: '#/components/schemas/v1Namespace'
    v1Namespace:
      type: object
      properties:
        metadata:
          $ref: '#/components/schemas/storageNamespaceMetadata'
        numDeployments:
          type: integer
          format: int32
        numSecrets:
          type: integer
          format: int32
        numNetworkPolicies:
          type: integer
          format: int32
    storageNamespaceMetadata:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        clusterId:
          type: string
        clusterName:
          type: string
        labels:
          type: object
          additionalProperties:
            type: string
        creationTime:
          type: string
          format: date-time
        priority:
          type: string
          format: int64
  securitySchemes:
    ApiToken:
      type: apiKey
      in: header
      name: Authorization
      description: 'StackRox API token. Format: Bearer {token}'