CRI-O Containers API

Endpoints that return information about live containers.

OpenAPI Specification

cri-o-containers-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: CRI-O Metrics Containers API
  description: The CRI-O metrics endpoint exposes Prometheus-compatible metrics for operations, image pulls, container lifecycle, and runtime errors. Metrics are enabled with the --enable-metrics daemon flag and served on the port configured by --metrics-port (default 9090) at the /metrics path. The endpoint can also be served over a Unix socket via --metrics-socket and secured using --metrics-cert and --metrics-key for TLS.
  version: '1.0'
  contact:
    name: CRI-O Project
    url: https://cri-o.io/
  license:
    name: Apache 2.0
    url: https://github.com/cri-o/cri-o/blob/main/LICENSE
servers:
- url: http://localhost:9090
  description: Default CRI-O metrics endpoint
tags:
- name: Containers
  description: Endpoints that return information about live containers.
paths:
  /containers/{id}:
    get:
      tags:
      - Containers
      operationId: getContainer
      summary: Get container info
      description: Returns runtime information about a single container by ID.
      parameters:
      - name: id
        in: path
        required: true
        description: Container ID.
        schema:
          type: string
      responses:
        '200':
          description: Container information
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContainerInfo'
        '404':
          description: Container not found
components:
  schemas:
    ContainerInfo:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        image:
          type: string
        pid:
          type: integer
        sandbox_id:
          type: string
        created_time:
          type: string
          format: date-time
externalDocs:
  description: CRI-O Metrics Documentation
  url: https://github.com/cri-o/cri-o/blob/main/docs/metrics.md