openapi: 3.2.0
info:
  title: Reference Metadata 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: Metadata Service
paths:
  /v1/metadata:
    get:
      operationId: GetMetadata
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v1Metadata'
      tags:
      - Metadata Service
      summary: Get metadata
      x-summary-source: derived
components:
  schemas:
    MetadataLicenseStatus:
      type: string
      enum:
      - NONE
      - INVALID
      - EXPIRED
      - RESTARTING
      - VALID
      default: NONE
    v1Metadata:
      type: object
      properties:
        version:
          type: string
        buildFlavor:
          type: string
        releaseBuild:
          type: boolean
          format: boolean
        licenseStatus:
          $ref: '#/components/schemas/MetadataLicenseStatus'
  securitySchemes:
    ApiToken:
      type: apiKey
      in: header
      name: Authorization
      description: 'StackRox API token. Format: Bearer {token}'