> ## 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 frr k8s effective advertise > Single-fetch aggregator: candidates + operator configs + bridge-node **Authorisation:** `cilium:GetState` on `krn:celum:supervisor:{name}:cilium:*`. **Assistant tool:** `get_frr_bgp_config` ## OpenAPI ````yaml /openapi.json get /api/supervisors/{name}/frr-k8s/effective-advertise 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}/frr-k8s/effective-advertise: get: tags: - networking summary: Get frr k8s effective advertise description: >- Single-fetch aggregator: candidates + operator configs + bridge-node **Authorisation:** `cilium:GetState` on `krn:celum:supervisor:{name}:cilium:*`. **Assistant tool:** `get_frr_bgp_config` operationId: get_supervisors_byName_frrK8s_effectiveAdvertise 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.effectiveAdvertiseResponse' 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.effectiveAdvertiseResponse: properties: candidates: $ref: '#/components/schemas/api.advertiseCandidates' operatorConfigs: items: $ref: '#/components/schemas/api.effectiveOperatorConfig' nullable: true type: array perNodeEgress: items: $ref: '#/components/schemas/api.effectivePerNodeEgress' nullable: true type: array warnings: items: type: string type: array required: - candidates - operatorConfigs - perNodeEgress type: object x-go-type: backend/internal/api.effectiveAdvertiseResponse api.ErrorBody: properties: error: type: string required: - error type: object api.advertiseCandidates: properties: egressPolicies: items: $ref: '#/components/schemas/api.egressPolicyCandidate' nullable: true type: array lbCIDRPools: items: $ref: '#/components/schemas/api.lbCIDRPoolCandidate' nullable: true type: array podCIDRPools: items: $ref: '#/components/schemas/api.podCIDRPoolCandidate' nullable: true type: array required: - egressPolicies - lbCIDRPools - podCIDRPools type: object x-go-type: backend/internal/api.advertiseCandidates api.effectiveOperatorConfig: properties: effectiveClusterPrefixes: items: type: string nullable: true type: array hasAnnotation: type: boolean name: type: string neighbors: items: $ref: '#/components/schemas/api.effectiveNeighbor' nullable: true type: array selection: $ref: '#/components/schemas/api.advertiseSelection' required: - effectiveClusterPrefixes - hasAnnotation - name - neighbors - selection type: object x-go-type: backend/internal/api.effectiveOperatorConfig api.effectivePerNodeEgress: properties: advertised: items: type: string nullable: true type: array agentError: type: string bridgeConfigName: type: string expected: items: type: string nullable: true type: array match: type: boolean node: type: string required: - advertised - expected - match - node type: object x-go-type: backend/internal/api.effectivePerNodeEgress api.egressPolicyCandidate: properties: egressIP: type: string name: type: string required: - egressIP - name type: object x-go-type: backend/internal/api.egressPolicyCandidate api.lbCIDRPoolCandidate: properties: cidrs: items: type: string nullable: true type: array name: type: string required: - cidrs - name type: object x-go-type: backend/internal/api.lbCIDRPoolCandidate api.podCIDRPoolCandidate: properties: cidrs: items: type: string nullable: true type: array name: type: string required: - cidrs - name type: object x-go-type: backend/internal/api.podCIDRPoolCandidate api.effectiveNeighbor: properties: address: type: string asn: format: int64 type: integer required: - address type: object x-go-type: backend/internal/api.effectiveNeighbor api.advertiseSelection: properties: egressPolicies: items: type: string nullable: true type: array lbCIDRPools: items: type: string nullable: true type: array podCIDRPools: items: type: string nullable: true type: array required: - egressPolicies - lbCIDRPools - podCIDRPools type: object x-go-type: backend/internal/api.advertiseSelection 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.