> ## 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 vmnetwork > **Authorisation:** `vm:Get` on `krn:celum:supervisor:{name}:vm:{vm}`, or on `krn:celum:supervisor:{name}:project:{?project}:vm:{vm}` — the project-qualified form, which is how a policy scopes a tenant to one project. Either resource matching is enough. **Assistant tool:** `get_vm_network`, `inspect_vm_guest` ## OpenAPI ````yaml /openapi.json get /api/supervisors/{name}/vms/{vm}/network 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}/vms/{vm}/network: get: tags: - vms summary: Get vmnetwork description: >- **Authorisation:** `vm:Get` on `krn:celum:supervisor:{name}:vm:{vm}`, or on `krn:celum:supervisor:{name}:project:{?project}:vm:{vm}` — the project-qualified form, which is how a policy scopes a tenant to one project. Either resource matching is enough. **Assistant tool:** `get_vm_network`, `inspect_vm_guest` operationId: get_supervisors_byName_vms_byVm_network parameters: - description: >- The supervisor's name, as registered under Administration → Supervisors. in: path name: name required: true schema: type: string - description: The virtual machine's name. in: path name: vm required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/api.VMNetworkResponse' 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. components: schemas: api.VMNetworkResponse: properties: bandwidth: $ref: '#/components/schemas/api.VMBandwidthBudget' interfaces: items: $ref: '#/components/schemas/api.VMNetInterface' nullable: true type: array overview: $ref: '#/components/schemas/api.VMNetOverview' path: $ref: '#/components/schemas/api.VMNetPath' routes: items: $ref: '#/components/schemas/api.VMNetRoute' nullable: true type: array services: items: $ref: '#/components/schemas/k8s.VMService' nullable: true type: array required: - bandwidth - interfaces - overview - path - routes - services type: object x-go-type: backend/internal/api.VMNetworkResponse api.ErrorBody: properties: error: type: string required: - error type: object api.VMBandwidthBudget: properties: conntrackLimit: format: int64 type: integer conntrackUsed: format: int64 type: integer egressCapBitsPerSec: format: int64 type: integer ingressCapBitsPerSec: format: int64 type: integer type: object x-go-type: backend/internal/api.VMBandwidthBudget api.VMNetInterface: properties: interface: type: string ip: type: string linkState: type: string mac: type: string name: type: string required: - name type: object x-go-type: backend/internal/api.VMNetInterface api.VMNetOverview: properties: bridge: type: string dns: type: string externalIP: type: string gateway: type: string internalIP: type: string model: type: string mtu: format: int64 type: integer netmask: type: string networkMode: type: string rxQueues: format: int64 type: integer txQueues: format: int64 type: integer required: - internalIP type: object x-go-type: backend/internal/api.VMNetOverview api.VMNetPath: properties: destinationCIDRs: items: type: string type: array egressPolicy: type: string hops: items: $ref: '#/components/schemas/api.VMNetPathHop' nullable: true type: array required: - hops type: object x-go-type: backend/internal/api.VMNetPath api.VMNetRoute: properties: hostnames: items: type: string type: array kind: type: string name: type: string namespace: type: string services: items: type: string type: array required: - kind - name - namespace type: object x-go-type: backend/internal/api.VMNetRoute k8s.VMService: properties: clusterIP: type: string externalIP: type: string name: type: string namespace: type: string ports: items: $ref: '#/components/schemas/k8s.VMServicePort' nullable: true type: array selector: additionalProperties: type: string type: object type: type: string required: - clusterIP - name - namespace - ports - type type: object x-go-type: backend/internal/k8s.VMService api.VMNetPathHop: properties: badge: type: string edgeLabel: type: string kind: type: string label: type: string required: - edgeLabel - kind - label type: object x-go-type: backend/internal/api.VMNetPathHop k8s.VMServicePort: properties: name: type: string nodePort: format: int32 type: integer port: format: int32 type: integer protocol: type: string targetPort: type: string required: - port - protocol type: object x-go-type: backend/internal/k8s.VMServicePort 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.