> ## Documentation Index
> Fetch the complete documentation index at: https://docs.celum.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Flow session pods

> Flow collection (Hubble → ClickHouse).

**Authorisation:** `security:Read` on `krn:celum:supervisor:{name}:security:*`.

**Assistant tool:** `get_flow_dimensions`



## OpenAPI

````yaml /openapi.json get /api/supervisors/{name}/security/flows/sessions/pods
openapi: 3.0.3
info:
  description: >-
    The HTTP surface of the Celum backend, generated from its own router and

    authorisation map — so this list cannot drift from the server that serves
    it.


    **Every operation states the IAM action and resource it is authorised

    against.** That pairing is the part worth reading: a policy naming the right

    action against the wrong resource matches nothing, and fails silently.


    Request and response bodies come from the Go types the handlers send and

    decode. Where those types do not determine the shape (an interface, a

    map[string]any, an unknown custom encoding), the operation says so in

    `x-celum-schema-gap` instead of carrying a guessed schema.
  title: Celum API
  version: 1.0.0
servers:
  - description: Your Celum deployment
    url: https://{host}
    variables:
      host:
        default: celum.example.com
        description: The host your Celum backend is served from
security:
  - sessionCookie: []
  - bearerToken: []
tags:
  - description: AI assistant & MCP
    name: ai-assistant
  - description: Clusters & CAPI lifecycle
    name: capi
  - description: Certificates & external secrets
    name: certs
  - description: GitOps & apps
    name: gitops
  - description: IAM, audit & auth
    name: iam
  - description: Image library
    name: images
  - description: Infrastructure & supervisors
    name: infrastructure
  - description: Networking
    name: networking
  - description: Observability & platform health
    name: observability
  - description: Platform onboarding & settings
    name: platform-settings
  - description: Projects
    name: projects
  - description: Registries & mirroring
    name: registries
  - description: Security & flows
    name: security
  - description: Storage
    name: storage
  - description: Templates & addons
    name: templates
  - description: Virtualization platform (KubeVirt/CDI)
    name: virt
  - description: Virtual machines
    name: vms
  - description: Workloads & topology
    name: workloads
paths:
  /api/supervisors/{name}/security/flows/sessions/pods:
    get:
      tags:
        - security
      summary: Flow session pods
      description: >-
        Flow collection (Hubble → ClickHouse).


        **Authorisation:** `security:Read` on
        `krn:celum:supervisor:{name}:security:*`.


        **Assistant tool:** `get_flow_dimensions`
      operationId: get_supervisors_byName_security_flows_sessions_pods
      parameters:
        - description: >-
            The supervisor's name, as registered under Administration →
            Supervisors.
          in: path
          name: name
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/clickhouse.Session'
                nullable: true
                type: array
          description: Success.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/api.ErrorBody'
          description: Bad Request.
        '401':
          description: Not authenticated — no valid session cookie or API token.
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/api.ErrorBody'
          description: >-
            Authenticated, but no policy allows this action on this resource.
            The body carries the action and resource that were evaluated.
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/api.ErrorBody'
          description: Bad Gateway.
components:
  schemas:
    clickhouse.Session:
      properties:
        actionClass:
          type: string
        bytesTotal:
          format: int64
          minimum: 0
          type: integer
        destPodName:
          type: string
        destPort:
          format: int32
          minimum: 0
          type: integer
        destWorkloadKind:
          type: string
        destWorkloadName:
          type: string
        destWorkloadNamespace:
          type: string
        dropCount:
          format: int64
          minimum: 0
          type: integer
        flowsCount:
          format: int64
          minimum: 0
          type: integer
        l7Count:
          format: int64
          minimum: 0
          type: integer
        l7LatencyMaxNs:
          format: int64
          minimum: 0
          type: integer
        newCount:
          format: int64
          minimum: 0
          type: integer
        packetsTotal:
          format: int64
          minimum: 0
          type: integer
        policyVerdictCount:
          format: int64
          minimum: 0
          type: integer
        protocol:
          type: string
        replyCount:
          format: int64
          minimum: 0
          type: integer
        sourcePodName:
          type: string
        sourceWorkloadKind:
          type: string
        sourceWorkloadName:
          type: string
        sourceWorkloadNamespace:
          type: string
        tcpFlagsOr:
          format: int32
          minimum: 0
          type: integer
        traceObservationPoints:
          items:
            type: string
          type: array
        trafficDirections:
          items:
            type: string
          type: array
        verdict:
          type: string
      required:
        - actionClass
        - bytesTotal
        - destPort
        - destWorkloadKind
        - destWorkloadName
        - destWorkloadNamespace
        - dropCount
        - flowsCount
        - l7Count
        - l7LatencyMaxNs
        - newCount
        - packetsTotal
        - policyVerdictCount
        - protocol
        - replyCount
        - sourceWorkloadKind
        - sourceWorkloadName
        - sourceWorkloadNamespace
        - tcpFlagsOr
        - verdict
      type: object
      x-go-type: backend/internal/clickhouse.Session
    api.ErrorBody:
      properties:
        error:
          type: string
      required:
        - error
      type: object
  securitySchemes:
    sessionCookie:
      description: >-
        The session cookie issued by the OIDC sign-in flow. This is what a
        browser uses.
      in: cookie
      name: k8s-gate-session
      type: apiKey
    bearerToken:
      description: >-
        An API token, minted from your own identity page. A token carries the
        IAM groups you held **when it was minted**, and cannot bypass deletion
        approval — except for guest clusters inside a project that same token
        created.
      scheme: bearer
      type: http

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.