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

# Get VM status by vmid

> Live Proxmox status for this service's VM. `vmid` must be the service's own vmid; anything else gets the same 404 as a
missing server, so vmids can't be enumerated. Prefer GET /v1/cloud/{id}, which doesn't need the vmid.



## OpenAPI

````yaml /api-reference/openapi.yaml get /v1/cloud/{id}/{vmid}
openapi: 3.1.0
info:
  title: Server.Express API
  version: 1.0.0
  description: >-
    The customer-facing Server.Express API: auth, billing, tickets, cloud and
    dedicated servers, hosting, reselling and account management. Every response
    uses the `{ success, data | error }` envelope.
  contact:
    name: Server.Express
    url: https://server.express
servers:
  - url: https://my.server.express/api
    description: Production
security:
  - bearerAuth: []
  - apiToken: []
tags:
  - name: API Tokens
  - name: Account
  - name: Auth
  - name: Cloud
  - name: Coupons
  - name: Credits
  - name: Dashboard
  - name: Dedicated
  - name: Health
  - name: Hosting
  - name: Integrations
  - name: Invoices
  - name: Livechat
  - name: Notifications
  - name: Passkeys
  - name: Payments
  - name: Products
  - name: Public
  - name: Public Invoices
  - name: Public Tools
  - name: Reseller
  - name: SSH Keys
  - name: Services
  - name: Tasks
  - name: Teams
  - name: Tickets
  - name: Web Hosting
  - name: Webhooks
paths:
  /v1/cloud/{id}/{vmid}:
    get:
      tags:
        - Cloud
      summary: Get VM status by vmid
      description: >-
        Live Proxmox status for this service's VM. `vmid` must be the service's
        own vmid; anything else gets the same 404 as a

        missing server, so vmids can't be enumerated. Prefer GET /v1/cloud/{id},
        which doesn't need the vmid.
      operationId: publicCloudGetVmStatus
      parameters:
        - name: id
          in: path
          required: true
          description: Service id of the cloud server.
          schema:
            type: string
            format: uuid
        - name: vmid
          in: path
          required: true
          description: The server's own Proxmox vmid. Any other number is answered 404.
          schema:
            type: integer
      responses:
        '200':
          description: >-
            Current VM status as reported by Proxmox (status/current, plus
            `node` and `vmid`).
          content:
            application/json:
              schema:
                type: object
                required:
                  - success
                  - data
                properties:
                  success:
                    type: boolean
                    const: true
                  data:
                    $ref: '#/components/schemas/PublicCloudProxmoxVm'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/ServerError'
        '503':
          description: The server hasn't been built yet. Retry later.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - bearerAuth: []
        - apiToken: []
components:
  schemas:
    PublicCloudProxmoxVm:
      type: object
      description: >-
        The VM as Proxmox reports it. Values are passed through from the
        hypervisor.
      properties:
        vmid:
          type: integer
        name:
          type: string
        status:
          type: string
          examples:
            - running
            - stopped
        cpu:
          type: number
          description: Fraction of all vCPUs in use, 0–1.
        cpus:
          type: integer
        mem:
          type: integer
          description: Bytes.
        maxmem:
          type: integer
          description: Bytes.
        disk:
          type: integer
          description: Bytes.
        maxdisk:
          type: integer
          description: Bytes.
        uptime:
          type: integer
          description: Seconds.
        node:
          type: string
          description: Hypervisor node name.
      additionalProperties: true
    ErrorResponse:
      type: object
      required:
        - success
        - error
      properties:
        success:
          type: boolean
          const: false
        error:
          type: string
          description: Human-readable error message.
      additionalProperties: true
  responses:
    BadRequest:
      description: Validation failed or the request is malformed.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Unauthorized:
      description: Missing, invalid or expired credentials.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Forbidden:
      description: >-
        Authenticated but not allowed (missing scope, not an admin, or not your
        resource).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    NotFound:
      description: The resource doesn't exist or isn't visible to you.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    ServerError:
      description: Unexpected server error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Session access token (JWT) from POST /v1/auth/login or /v1/auth/refresh.
        A session satisfies every API scope.
    apiToken:
      type: http
      scheme: bearer
      bearerFormat: se_live_<prefix>_<secret>
      description: >-
        Personal API token created under Settings → API tokens. Only routes
        guarded by verifyApiAuth accept it, and the token must carry the scope
        named in the operation's x-required-scope.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.