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

# Get omni cluster config

> Single-fetch aggregator: candidates + operator configs + bridge-node

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

**Assistant tool:** `get_omni_config`



## OpenAPI

````yaml /openapi.json get /api/supervisors/{name}/omni/cluster-config
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}/omni/cluster-config:
    get:
      tags:
        - capi
      summary: Get omni cluster config
      description: >-
        Single-fetch aggregator: candidates + operator configs + bridge-node


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


        **Assistant tool:** `get_omni_config`
      operationId: get_supervisors_byName_omni_clusterConfig
      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:
                allOf:
                  - $ref: '#/components/schemas/omni.ClusterConfig'
                nullable: true
                type: object
          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':
          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.
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/api.ErrorBody'
          description: Service Unavailable.
components:
  schemas:
    omni.ClusterConfig:
      properties:
        cniName:
          type: string
        dnsDomain:
          type: string
        kubePrismEnabled:
          type: boolean
        kubePrismPort:
          format: int64
          type: integer
        kubeletNodeSubnets:
          items:
            type: string
          type: array
        kubernetesVersion:
          type: string
        name:
          type: string
        nodeInterfaces:
          items:
            type: string
          type: array
        nodeNetworks:
          items:
            type: string
          type: array
        patchIDs:
          items:
            type: string
          type: array
        podSubnets:
          items:
            type: string
          type: array
        proxyDisabled:
          type: boolean
        serviceSubnets:
          items:
            type: string
          type: array
        talosVersion:
          type: string
        topology:
          $ref: '#/components/schemas/omni.NetworkTopology'
      required:
        - kubePrismEnabled
        - kubernetesVersion
        - name
        - proxyDisabled
        - talosVersion
      type: object
      x-go-type: backend/internal/omni.ClusterConfig
    api.ErrorBody:
      properties:
        error:
          type: string
      required:
        - error
      type: object
    omni.NetworkTopology:
      properties:
        bonds:
          items:
            $ref: '#/components/schemas/omni.BondIface'
          type: array
        l3:
          items:
            $ref: '#/components/schemas/omni.L3Iface'
          type: array
        physical:
          items:
            $ref: '#/components/schemas/omni.PhysicalNIC'
          type: array
      type: object
      x-go-type: backend/internal/omni.NetworkTopology
    omni.BondIface:
      properties:
        mode:
          type: string
        mtu:
          format: int64
          type: integer
        name:
          type: string
        slaves:
          items:
            type: string
          type: array
        up:
          type: boolean
      required:
        - name
      type: object
      x-go-type: backend/internal/omni.BondIface
    omni.L3Iface:
      properties:
        addresses:
          items:
            type: string
          type: array
        defaultRoute:
          type: boolean
        dhcp:
          type: boolean
        gateway:
          type: string
        mtu:
          format: int64
          type: integer
        name:
          type: string
        networks:
          items:
            type: string
          type: array
        parent:
          type: string
        up:
          type: boolean
        vip:
          type: string
        vlan:
          format: int64
          type: integer
      required:
        - name
      type: object
      x-go-type: backend/internal/omni.L3Iface
    omni.PhysicalNIC:
      properties:
        mtu:
          format: int64
          type: integer
        name:
          type: string
        slaveOf:
          type: string
        up:
          type: boolean
      required:
        - name
      type: object
      x-go-type: backend/internal/omni.PhysicalNIC
  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.