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

# Get VM details



## OpenAPI

````yaml /api-reference/openapi.json get /vms/{vm_id}
openapi: 3.0.0
info:
  title: Shard Cloud API
  description: >-
    API reference for Shard Cloud's authenticated management endpoints — Apps,
    Databases, VMs, Custom Docker Images, and project-level Alerts & Backups.
    Every endpoint on this page requires a JWT bearer token (see Authentication
    below). CDN endpoints have their own reference under the CDN tab.
  version: 2.0.0
servers:
  - url: https://shardcloud.app/api
    description: API base path
security: []
tags:
  - name: Databases
    description: PostgreSQL, MySQL, MongoDB, and Redis database services.
  - name: Apps
    description: Web application deployment, files, domains, and configuration.
  - name: VMs
    description: Full Linux virtual machines with SSH access.
  - name: Custom Images
    description: User-built Docker images, deployable straight to an App.
  - name: Project
    description: >-
      Resource alerts and backups — shared across App, Database, and VM
      projects.
paths:
  /vms/{vm_id}:
    get:
      tags:
        - VMs
      summary: Get VM details
      parameters:
        - name: vm_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: VM details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VMResponse'
        '404':
          description: VM not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - JWTAuth: []
components:
  schemas:
    VMResponse:
      type: object
      properties:
        vm:
          $ref: '#/components/schemas/VM'
        project_info:
          $ref: '#/components/schemas/ProjectInfo'
        status:
          type: string
          enum:
            - not_found
            - pending
            - running
            - stopped
    Error:
      type: object
      properties:
        error:
          type: string
    VM:
      allOf:
        - $ref: '#/components/schemas/Project'
        - type: object
          properties:
            distro:
              type: string
            ip:
              type: string
            node:
              type: string
            description:
              type: string
            storage:
              type: integer
              description: Storage in MB, auto-sized from RAM.
            template:
              type: string
              description: VPS template ID this VM was created from, if any.
    ProjectInfo:
      type: object
      description: >-
        Time-series resource usage, one point per sampled step over the
        requested window.
      properties:
        ram:
          type: array
          items:
            type: number
        vcpu:
          type: array
          items:
            type: number
        storage:
          type: integer
        network_receive:
          type: array
          items:
            type: number
        network_send:
          type: array
          items:
            type: number
    Project:
      type: object
      description: Fields shared by every resource type (App, DatabaseService, VM).
      properties:
        id:
          type: string
          format: uuid
        user_id:
          type: string
          format: uuid
        workspace_id:
          type: string
          format: uuid
          description: Present only when the resource belongs to a workspace.
        ram:
          type: integer
          description: RAM in MB.
        vcpu:
          type: integer
        name:
          type: string
        is_app:
          type: boolean
        project_type:
          type: string
          enum:
            - app
            - database
            - virtual_machine
        blocked_until:
          type: string
          format: date-time
          nullable: true
        blocked_reason:
          type: string
          nullable: true
        setup:
          type: boolean
        created_at:
          type: string
          format: date-time
          nullable: true
        auto_backup:
          type: boolean
  securitySchemes:
    JWTAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Send your API token (Dashboard → Settings → API Token) as
        `Authorization: Bearer <token>`.

````