> ## 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.

# Configure flow pipeline

> The one-off move of the shared gateway into envoy-gateway-system with

**Authorisation:** `monitoring:Install` on `krn:celum:supervisor:{name}:monitoring:*`.



## OpenAPI

````yaml /openapi.json post /api/supervisors/{name}/flow-pipeline/configure
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}/flow-pipeline/configure:
    post:
      tags:
        - observability
      summary: Configure flow pipeline
      description: >-
        The one-off move of the shared gateway into envoy-gateway-system with


        **Authorisation:** `monitoring:Install` on
        `krn:celum:supervisor:{name}:monitoring:*`.
      operationId: post_supervisors_byName_flowPipeline_configure
      parameters:
        - description: >-
            The supervisor's name, as registered under Administration →
            Supervisors.
          in: path
          name: name
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/api.FlowPipelineConfigureRequest.Input'
        required: false
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/api.FlowPipelineConfigureResponse'
          description: Accepted.
        '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':
          description: >-
            Authenticated, but no policy allows this action on this resource.
            The body carries the action and resource that were evaluated.
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/api.ErrorBody'
          description: Conflict.
        '412':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/api.ErrorBody'
          description: Precondition Failed.
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/api.ErrorBody'
          description: Bad Gateway.
components:
  schemas:
    api.FlowPipelineConfigureRequest.Input:
      properties:
        clusterAgentChartVersion:
          type: string
        clusterAgentImageTag:
          type: string
        clusterName:
          type: string
        dsnOverride:
          type: string
        enableCT:
          type: boolean
        enableGwlog:
          type: boolean
        enableHubble:
          type: boolean
        enableTetragon:
          type: boolean
        enableTlsSni:
          type: boolean
        gwlogFilters:
          $ref: '#/components/schemas/api.GatewayAccessLogFilters.Input'
        schemaChartVersion:
          type: string
      type: object
      x-go-type: backend/internal/api.FlowPipelineConfigureRequest
    api.FlowPipelineConfigureResponse:
      properties:
        alerts:
          properties:
            applied:
              type: boolean
            rule:
              type: string
            warnings:
              items:
                type: string
              type: array
          required:
            - applied
            - rule
          type: object
        clusterAgentRelease:
          properties:
            action:
              type: string
            name:
              type: string
            version:
              type: string
          required:
            - action
            - name
            - version
          type: object
        dnsVisibility:
          properties:
            applied:
              type: boolean
            name:
              type: string
            warnings:
              items:
                type: string
              type: array
          required:
            - applied
            - name
          type: object
        dsn:
          type: string
        flowsSecret:
          properties:
            created:
              type: boolean
            name:
              type: string
            namespace:
              type: string
          required:
            - created
            - name
            - namespace
          type: object
        gatewayAccessLog:
          properties:
            applied:
              type: boolean
            enabled:
              type: boolean
            proxies:
              format: int64
              type: integer
            warnings:
              items:
                type: string
              type: array
          required:
            - applied
            - enabled
            - proxies
          type: object
        guestWriters:
          items:
            $ref: '#/components/schemas/api.capiInstallStepResult'
          type: array
        ownCredentials:
          items:
            $ref: '#/components/schemas/api.capiInstallStepResult'
          type: array
        schemaBootstrap:
          properties:
            configMapHash:
              type: string
            configMapName:
              type: string
            elapsedMs:
              format: int64
              type: integer
            statementsRun:
              format: int64
              type: integer
            tablesPresent:
              format: int64
              type: integer
          required:
            - configMapName
            - elapsedMs
            - statementsRun
            - tablesPresent
          type: object
        schemaRelease:
          properties:
            action:
              type: string
            name:
              type: string
            version:
              type: string
          required:
            - action
            - name
            - version
          type: object
        warnings:
          items:
            type: string
          type: array
      required:
        - alerts
        - clusterAgentRelease
        - dnsVisibility
        - dsn
        - flowsSecret
        - gatewayAccessLog
        - schemaBootstrap
        - schemaRelease
      type: object
      x-go-type: backend/internal/api.FlowPipelineConfigureResponse
    api.ErrorBody:
      properties:
        error:
          type: string
      required:
        - error
      type: object
    api.GatewayAccessLogFilters.Input:
      properties:
        errorsOnly:
          type: boolean
        skipProbes:
          type: boolean
      type: object
      x-go-type: backend/internal/api.GatewayAccessLogFilters
    api.capiInstallStepResult:
      properties:
        action:
          type: string
        kind:
          type: string
        name:
          type: string
      required:
        - action
        - kind
        - name
      type: object
      x-go-type: backend/internal/api.capiInstallStepResult
  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.