> ## 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 vmmetrics > **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_metrics` ## OpenAPI ````yaml /openapi.json get /api/supervisors/{name}/vms/{vm}/metrics 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}/metrics: get: tags: - vms summary: Get vmmetrics 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_metrics` operationId: get_supervisors_byName_vms_byVm_metrics 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.VMMetricsResponse' 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. '503': content: application/json: schema: $ref: '#/components/schemas/api.ErrorBody' description: Service Unavailable. components: schemas: api.VMMetricsResponse: properties: current: properties: capacityBytes: type: number capacityUsedBytes: type: number cpuPercent: type: number diskReadBytesPerSec: type: number diskReadIOPS: type: number diskWriteBytesPerSec: type: number diskWriteIOPS: type: number memTotalMiB: type: number memUsedMiB: type: number netInKiBPerSec: type: number netOutKiBPerSec: type: number required: - capacityBytes - capacityUsedBytes - cpuPercent - diskReadBytesPerSec - diskReadIOPS - diskWriteBytesPerSec - diskWriteIOPS - memTotalMiB - memUsedMiB - netInKiBPerSec - netOutKiBPerSec type: object range: type: string series: properties: cpu: items: $ref: '#/components/schemas/api.TSPoint' nullable: true type: array diskRead: items: $ref: '#/components/schemas/api.TSPoint' nullable: true type: array diskReadBytes: items: $ref: '#/components/schemas/api.TSPoint' nullable: true type: array diskWrite: items: $ref: '#/components/schemas/api.TSPoint' nullable: true type: array diskWriteBytes: items: $ref: '#/components/schemas/api.TSPoint' nullable: true type: array mem: items: $ref: '#/components/schemas/api.TSPoint' nullable: true type: array netIn: items: $ref: '#/components/schemas/api.TSPoint' nullable: true type: array netOut: items: $ref: '#/components/schemas/api.TSPoint' nullable: true type: array required: - cpu - diskRead - diskReadBytes - diskWrite - diskWriteBytes - mem - netIn - netOut type: object source: type: string stats: additionalProperties: $ref: '#/components/schemas/api.TileStats' nullable: true type: object stepSec: format: int64 type: integer required: - current - range - series - source - stats - stepSec type: object x-go-type: backend/internal/api.VMMetricsResponse api.ErrorBody: properties: error: type: string required: - error type: object api.TSPoint: properties: t: format: int64 type: integer v: type: number required: - t - v type: object x-go-type: backend/internal/api.TSPoint api.TileStats: properties: avg: type: number peak: type: number required: - avg - peak type: object x-go-type: backend/internal/api.TileStats 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.