> ## 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 routing plan

> Routing plan — Prerequisites "Routing" intent (static vs BGP/FRR) + the

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



## OpenAPI

````yaml /openapi.json get /api/supervisors/{name}/networking/routing-plan
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}/networking/routing-plan:
    get:
      tags:
        - networking
      summary: Get routing plan
      description: >-
        Routing plan — Prerequisites "Routing" intent (static vs BGP/FRR) + the


        **Authorisation:** `cilium:GetState` on
        `krn:celum:supervisor:{name}:cilium:*`.
      operationId: get_supervisors_byName_networking_routingPlan
      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:
                $ref: '#/components/schemas/api.RoutingPlanResponse'
          description: Success.
        '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.
components:
  schemas:
    api.RoutingPlanResponse:
      properties:
        bfdTimers:
          $ref: '#/components/schemas/api.routingBFDTimers'
        blockCidr:
          type: string
        intent:
          $ref: '#/components/schemas/api.RoutingIntent'
        lbCidr:
          type: string
        nodes:
          items:
            $ref: '#/components/schemas/api.RoutingNode'
          nullable: true
          type: array
        note:
          type: string
        ourASEffective:
          format: int64
          type: integer
        secretStoreConfigured:
          type: boolean
      required:
        - bfdTimers
        - intent
        - lbCidr
        - nodes
        - ourASEffective
        - secretStoreConfigured
      type: object
      x-go-type: backend/internal/api.RoutingPlanResponse
    api.ErrorBody:
      properties:
        error:
          type: string
      required:
        - error
      type: object
    api.routingBFDTimers:
      properties:
        detectMultiplier:
          format: int64
          type: integer
        receiveIntervalMs:
          format: int64
          type: integer
        transmitIntervalMs:
          format: int64
          type: integer
      required:
        - detectMultiplier
        - receiveIntervalMs
        - transmitIntervalMs
      type: object
      x-go-type: backend/internal/api.routingBFDTimers
    api.RoutingIntent:
      properties:
        bfd:
          type: boolean
        infraAS:
          format: int64
          type: integer
        infraPeers:
          items:
            type: string
          type: array
        md5:
          type: boolean
        md5Password:
          type: string
        ourAS:
          format: int64
          type: integer
        softReconfig:
          type: boolean
        type:
          type: string
      required:
        - type
      type: object
      x-go-type: backend/internal/api.RoutingIntent
    api.RoutingNode:
      properties:
        interface:
          type: string
        name:
          type: string
        note:
          type: string
        primaryIP:
          type: string
        role:
          type: string
        source:
          type: string
      required:
        - name
        - primaryIP
        - role
      type: object
      x-go-type: backend/internal/api.RoutingNode
  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.