> ## 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.

# Run shell commands inside the VM

> Server-Sent Events stream of command output, one or more commands run in order (up to 50 per request). Heartbeat comment every 10s.



## OpenAPI

````yaml /api-reference/openapi.json post /vms/{vm_id}/exec
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}/exec:
    post:
      tags:
        - VMs
      summary: Run shell commands inside the VM
      description: >-
        Server-Sent Events stream of command output, one or more commands run in
        order (up to 50 per request). Heartbeat comment every 10s.
      parameters:
        - name: vm_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExecInVMRequest'
      responses:
        '200':
          description: >-
            text/event-stream of `output` events: { command_index, output,
            is_error, command_done, exit_code, timed_out, error, batch_done }
          content:
            text/event-stream:
              schema:
                type: string
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: No valid subscription
      security:
        - JWTAuth: []
components:
  schemas:
    ExecInVMRequest:
      type: object
      required:
        - commands
      properties:
        cwd:
          type: string
        commands:
          type: array
          maxItems: 50
          items:
            $ref: '#/components/schemas/VMCommandRequest'
    Error:
      type: object
      properties:
        error:
          type: string
    VMCommandRequest:
      type: object
      required:
        - cmd
      properties:
        cmd:
          type: string
        args:
          type: array
          items:
            type: string
        timeout_sec:
          type: integer
        cwd:
          type: string
  securitySchemes:
    JWTAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Send your API token (Dashboard → Settings → API Token) as
        `Authorization: Bearer <token>`.

````