> ## Documentation Index
> Fetch the complete documentation index at: https://docs.rigbox.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Workspace Metrics

> Get live CPU, memory, and disk usage metrics for a running workspace.



## OpenAPI

````yaml GET /api/v1/workspaces/{id}/metrics
openapi: 3.1.0
info:
  title: Rigbox Public API
  description: >-
    Gateway-owned public API for Rigbox. The gateway composes its local
    lifecycle API with service-owned exported specs.
  contact:
    name: Rigbox
    url: https://rigbox.dev
  license:
    name: ''
  version: 1.0.0
servers:
  - url: https://api.rigbox.dev
    description: Production gateway
security: []
tags:
  - name: Workspaces
  - name: CLI
  - name: Observability
  - name: Auth
  - name: API Keys
  - name: Access Control
  - name: Apps
  - name: App Catalog
  - name: Logs
  - name: AI
  - name: Tools
  - name: Snapshots
  - name: SSH Keys
  - name: Templates
  - name: Setup Scripts
  - name: Service Specs
  - name: Deploy
  - name: Community
  - name: User Settings
  - name: Roadmap
  - name: System
paths:
  /api/v1/workspaces/{id}/metrics:
    get:
      tags:
        - Workspaces
      summary: Get live resource metrics for a workspace.
      description: Live CPU, memory, and disk usage for the running workspace VM.
      operationId: get_workspace_metrics
      parameters:
        - name: id
          in: path
          description: Workspace ID
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Workspace resource metrics
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkspaceMetrics'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorBody'
      security:
        - bearer: []
components:
  schemas:
    WorkspaceMetrics:
      type: object
      required:
        - workspace_id
        - ram_used_mb
        - ram_total_mb
        - disk_used_mb
        - disk_total_mb
        - cpu_percent
        - updated_at
      properties:
        cpu_percent:
          type: number
          format: double
        disk_total_mb:
          type: integer
          format: int32
        disk_used_mb:
          type: integer
          format: int32
        ram_total_mb:
          type: integer
          format: int32
        ram_used_mb:
          type: integer
          format: int32
        updated_at:
          type: string
          format: date-time
        workspace_id:
          type: string
    ApiErrorBody:
      type: object
      description: JSON body returned for all errors.
      required:
        - error
      properties:
        error:
          $ref: '#/components/schemas/ApiErrorDetail'
    ApiErrorDetail:
      type: object
      required:
        - code
        - message
      properties:
        code:
          type: string
        details: {}
        message:
          type: string
  securitySchemes:
    bearer:
      type: http
      scheme: bearer

````