> ## 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 networking overview > Security Platform **Authorisation:** `cilium:GetState` on `krn:celum:supervisor:{name}:cilium:*`. **Assistant tool:** `get_networking_overview` ## OpenAPI ````yaml /openapi.json get /api/supervisors/{name}/networking/overview 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/overview: get: tags: - networking summary: Get networking overview description: >- Security Platform **Authorisation:** `cilium:GetState` on `krn:celum:supervisor:{name}:cilium:*`. **Assistant tool:** `get_networking_overview` operationId: get_supervisors_byName_networking_overview 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.networkingOverviewResponse' 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.networkingOverviewResponse: properties: bgpNodes: items: $ref: '#/components/schemas/k8s.BGPNodeStatus' nullable: true type: array domainInfo: allOf: - $ref: '#/components/schemas/api.DomainInfo' nullable: true type: object egressPolicies: items: $ref: '#/components/schemas/k8s.EgressGatewayPolicy' nullable: true type: array gateways: items: $ref: '#/components/schemas/k8s.GatewayInfo' nullable: true type: array podIPPools: items: $ref: '#/components/schemas/k8s.PodIPPool' nullable: true type: array pools: items: $ref: '#/components/schemas/k8s.LBPool' nullable: true type: array routes: items: $ref: '#/components/schemas/k8s.GatewayIngress' nullable: true type: array servicePoolIntent: type: string required: - bgpNodes - domainInfo - egressPolicies - gateways - podIPPools - pools - routes - servicePoolIntent type: object x-go-type: backend/internal/api.networkingOverviewResponse api.ErrorBody: properties: error: type: string required: - error type: object k8s.BGPNodeStatus: properties: nodeName: type: string peers: items: $ref: '#/components/schemas/k8s.BGPPeerStatus' nullable: true type: array required: - nodeName - peers type: object x-go-type: backend/internal/k8s.BGPNodeStatus api.DomainInfo: properties: domain: type: string subdomain: type: string required: - domain - subdomain type: object x-go-type: backend/internal/api.DomainInfo k8s.EgressGatewayPolicy: properties: destinationCIDRs: items: type: string nullable: true type: array egressGateway: $ref: '#/components/schemas/k8s.EgressGatewaySpec' excludedCIDRs: items: type: string type: array labels: additionalProperties: type: string type: object name: type: string selectors: items: $ref: '#/components/schemas/k8s.EgressSelector' nullable: true type: array required: - destinationCIDRs - egressGateway - name - selectors type: object x-go-type: backend/internal/k8s.EgressGatewayPolicy k8s.GatewayInfo: properties: address: type: string class: type: string datapath: type: string dedicated: type: boolean engine: type: string hostnames: items: type: string nullable: true type: array name: type: string namespace: type: string ready: type: boolean required: - address - class - hostnames - name - namespace - ready type: object x-go-type: backend/internal/k8s.GatewayInfo k8s.PodIPPool: properties: ipv4CIDRs: items: type: string type: array ipv4MaskSize: format: int64 type: integer ipv6CIDRs: items: type: string type: array ipv6MaskSize: format: int64 type: integer labels: additionalProperties: type: string type: object name: type: string namespaceSelector: additionalProperties: type: string type: object podSelector: additionalProperties: type: string type: object required: - name type: object x-go-type: backend/internal/k8s.PodIPPool k8s.LBPool: properties: allowFirstLastIPs: type: string blocks: items: $ref: '#/components/schemas/k8s.LBBlock' nullable: true type: array conflict: type: boolean disabled: type: boolean ipsAvailable: format: int64 type: integer ipsTotal: format: int64 type: integer ipsUsed: format: int64 type: integer labels: additionalProperties: type: string type: object name: type: string project: type: string serviceSelector: additionalProperties: type: string type: object required: - blocks - conflict - disabled - ipsAvailable - ipsTotal - ipsUsed - name type: object x-go-type: backend/internal/k8s.LBPool k8s.GatewayIngress: properties: address: type: string gateway: type: string hostname: type: string hostnames: items: type: string type: array issuer: type: string name: type: string namespace: type: string orphaned: type: boolean paths: items: type: string type: array ready: type: boolean redirect: type: boolean service: type: string tls: type: boolean required: - address - hostname - name - namespace - ready - service - tls type: object x-go-type: backend/internal/k8s.GatewayIngress k8s.BGPPeerStatus: properties: localAsn: format: int64 type: integer peerAddress: type: string peerAsn: format: int64 type: integer routes: items: $ref: '#/components/schemas/k8s.BGPRouteCount' nullable: true type: array sessionState: type: string required: - localAsn - peerAddress - peerAsn - routes - sessionState type: object x-go-type: backend/internal/k8s.BGPPeerStatus k8s.EgressGatewaySpec: properties: egressIP: type: string interface: type: string nodeSelector: additionalProperties: type: string nullable: true type: object required: - nodeSelector type: object x-go-type: backend/internal/k8s.EgressGatewaySpec k8s.EgressSelector: properties: namespaceSelector: additionalProperties: type: string type: object podSelector: additionalProperties: type: string type: object type: object x-go-type: backend/internal/k8s.EgressSelector k8s.LBBlock: properties: cidr: type: string start: type: string stop: type: string type: object x-go-type: backend/internal/k8s.LBBlock k8s.BGPRouteCount: properties: advertised: format: int64 type: integer afi: type: string received: format: int64 type: integer safi: type: string required: - advertised - afi - received - safi type: object x-go-type: backend/internal/k8s.BGPRouteCount 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.