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

# Get CVM details

> Returns full CVM details including status, network info, and KMS configuration.



## OpenAPI

````yaml /openapi.json get /api/v1/cvms/{cvm_id}
openapi: 3.1.0
info:
  title: Phala Cloud API
  version: 0.1.0
servers:
  - url: https://cloud-api.phala.com
security: []
tags:
  - name: CVMs
    description: Confidential Virtual Machine (CVM) lifecycle management on Phala Network
  - name: Apps
    description: App template management and CVM deployment from app blueprints
  - name: Webhooks
    description: Manage webhook endpoints and monitor delivery history
  - name: SSH Keys
    description: SSH public key management for CVM access
  - name: KMS
    description: >-
      Key Management Service — key derivation, on-chain anchoring, and
      inspection
  - name: Instance Types
    description: Available hardware configurations for CVM deployment
  - name: Attestations
    description: Remote attestation and TEE verification endpoints
paths:
  /api/v1/cvms/{cvm_id}:
    get:
      tags:
        - CVMs
      summary: Get CVM details
      description: >-
        Returns full CVM details including status, network info, and KMS
        configuration.
      operationId: handle_get_cvm_api_v1_cvms__cvm_id__get
      parameters:
        - name: cvm_id
          in: path
          required: true
          schema:
            type: string
            title: Cvm Id
      responses:
        '200':
          description: CVM details
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: >-
                      #/components/schemas/teehouse__api__routes__cvms__management__CvmBasicInfo
                  - $ref: '#/components/schemas/CVMInfoDetail'
                title: Response Handle Get Cvm Api V1 Cvms  Cvm Id  Get
        '401':
          description: Authentication required
        '403':
          description: CVM not in workspace
        '404':
          description: CVM not found
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - OAuth2AuthorizationCodeBearer: []
        - APIKeyHeader: []
components:
  schemas:
    teehouse__api__routes__cvms__management__CvmBasicInfo:
      properties:
        id:
          type: integer
          title: Id
          description: Internal CVM database ID
        teepod_id:
          anyOf:
            - type: integer
            - type: 'null'
          title: Teepod Id
          description: Node ID (admin only)
        teepod:
          anyOf:
            - $ref: '#/components/schemas/CvmNode'
            - type: 'null'
          description: Node metadata
        name:
          type: string
          title: Name
          description: RFC 1123 compliant CVM name
        status:
          type: string
          title: Status
          description: 'Current status: running, stopped, starting, etc.'
        in_progress:
          type: boolean
          title: In Progress
          description: True if an operation is currently executing
          default: false
        app_id:
          type: string
          title: App Id
          description: Unique application identifier
        vm_uuid:
          anyOf:
            - type: string
            - type: 'null'
          title: Vm Uuid
          description: VM instance UUID on the node
        instance_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Instance Id
          description: Public instance identifier
        vcpu:
          type: integer
          title: Vcpu
          description: Allocated vCPU count
        memory:
          type: integer
          title: Memory
          description: Allocated memory in MB
        disk_size:
          type: integer
          title: Disk Size
          description: Allocated disk size in GB
        base_image:
          anyOf:
            - type: string
            - type: 'null'
          title: Base Image
          description: OS image name
        encrypted_env_pubkey:
          anyOf:
            - type: string
            - type: 'null'
          title: Encrypted Env Pubkey
          description: Public key for encrypting env vars
        listed:
          type: boolean
          title: Listed
          description: True if publicly listed
          default: false
        project_id:
          anyOf:
            - type: string
              format: hashid
              description: A hashed identifier that maps to an internal database ID
              examples:
                - 0123abcd
            - type: 'null'
          title: Project Id
          description: Associated project ID
        project_type:
          anyOf:
            - type: string
            - type: 'null'
          title: Project Type
          description: Project provision type
        instance_type:
          anyOf:
            - type: string
            - type: 'null'
          title: Instance Type
          description: Instance type identifier
        public_sysinfo:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Public Sysinfo
          description: Expose system info publicly
        public_logs:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Public Logs
          description: Expose logs publicly
        dapp_dashboard_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Dapp Dashboard Url
          description: DApp dashboard URL if applicable
        syslog_endpoint:
          anyOf:
            - type: string
            - type: 'null'
          title: Syslog Endpoint
          description: Syslog streaming endpoint
        kms_info:
          anyOf:
            - $ref: '#/components/schemas/KMSInfo'
            - type: 'null'
          description: KMS configuration
        contract_address:
          anyOf:
            - type: string
            - type: 'null'
          title: Contract Address
          description: On-chain contract address
        deployer_address:
          anyOf:
            - type: string
            - type: 'null'
          title: Deployer Address
          description: Deployer wallet address
        scheduled_delete_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Scheduled Delete At
          description: Auto-delete timestamp (UTC)
        public_urls:
          anyOf:
            - items:
                $ref: '#/components/schemas/CvmNetworkUrls'
              type: array
            - type: 'null'
          title: Public Urls
          description: Exposed service URLs
        gateway_domain:
          anyOf:
            - type: string
            - type: 'null'
          title: Gateway Domain
          description: Gateway base domain
      type: object
      required:
        - id
        - name
        - status
        - app_id
        - vcpu
        - memory
        - disk_size
      title: CvmBasicInfo
      description: Detailed CVM information returned by GET /cvms/{cvm_id}.
    CVMInfoDetail:
      properties:
        id:
          type: string
          pattern: ^cvm_.+
          format: hashid
          title: HashedId[cvms]
          description: A hashed identifier that maps to an internal database ID
          examples:
            - cvm_0123abcd
        name:
          type: string
          title: Name
        app_id:
          anyOf:
            - type: string
            - type: 'null'
          title: App Id
        vm_uuid:
          anyOf:
            - type: string
            - type: 'null'
          title: Vm Uuid
        instance_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Instance Id
        resource:
          $ref: '#/components/schemas/CVMResourceInfo'
        node_info:
          anyOf:
            - $ref: '#/components/schemas/NodeRef'
            - type: 'null'
        os:
          anyOf:
            - $ref: '#/components/schemas/CVMOSInfo'
            - type: 'null'
        kms_type:
          anyOf:
            - $ref: '#/components/schemas/KmsType'
            - type: 'null'
        kms_info:
          anyOf:
            - $ref: '#/components/schemas/CVMKmsInfo'
            - type: 'null'
        status:
          type: string
          title: Status
        in_progress:
          type: boolean
          title: In Progress
          default: false
        progress:
          anyOf:
            - $ref: '#/components/schemas/CVMProgressInfo'
            - type: 'null'
        compose_hash:
          anyOf:
            - type: string
            - type: 'null'
          title: Compose Hash
        docker_compose_hash:
          anyOf:
            - type: string
            - type: 'null'
          title: Docker Compose Hash
        pre_launch_script_hash:
          anyOf:
            - type: string
            - type: 'null'
          title: Pre Launch Script Hash
        gateway:
          $ref: '#/components/schemas/CVMGatewayInfo'
        logs:
          $ref: '#/components/schemas/CVMLogUrls'
        services:
          items:
            additionalProperties: true
            type: object
          type: array
          title: Services
        endpoints:
          anyOf:
            - items:
                $ref: '#/components/schemas/CvmNetworkUrls'
              type: array
            - type: 'null'
          title: Endpoints
        public_logs:
          type: boolean
          title: Public Logs
          default: false
        public_sysinfo:
          type: boolean
          title: Public Sysinfo
          default: false
        public_tcbinfo:
          type: boolean
          title: Public Tcbinfo
          default: true
        gateway_enabled:
          type: boolean
          title: Gateway Enabled
          default: false
        secure_time:
          type: boolean
          title: Secure Time
          default: false
        storage_fs:
          type: string
          title: Storage Fs
          default: zfs
        workspace:
          anyOf:
            - $ref: '#/components/schemas/WorkspaceRef'
            - type: 'null'
        creator:
          anyOf:
            - $ref: '#/components/schemas/UserRef'
            - type: 'null'
        created_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Created At
        deleted_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Deleted At
        listed:
          type: boolean
          title: Listed
          default: false
        project_type:
          anyOf:
            - type: string
            - type: 'null'
          title: Project Type
        compose_file:
          anyOf:
            - additionalProperties: true
              type: object
            - type: string
            - type: 'null'
          title: Compose File
      type: object
      required:
        - id
        - name
        - resource
        - status
        - gateway
      title: CVMInfoDetail
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    CvmNode:
      properties:
        id:
          type: integer
          title: Id
        name:
          type: string
          title: Name
        region_identifier:
          anyOf:
            - type: string
            - type: 'null'
          title: Region Identifier
      type: object
      required:
        - id
        - name
      title: CvmNode
    KMSInfo:
      properties:
        id:
          type: string
          pattern: ^kms_.+
          format: hashid
          title: HashedId[kms]
          description: Hashed KMS identifier (kms_xxxxx)
          examples:
            - kms_0123abcd
        slug:
          anyOf:
            - type: string
            - type: 'null'
          title: Slug
          description: Human-readable KMS name
        url:
          type: string
          title: Url
          description: KMS endpoint URL
        version:
          type: string
          title: Version
          description: KMS software version
        chain_id:
          anyOf:
            - type: integer
            - type: 'null'
          title: Chain Id
          description: Blockchain chain ID if onchain
        kms_contract_address:
          anyOf:
            - type: string
            - type: 'null'
          title: Kms Contract Address
          description: Smart contract address if onchain
        gateway_app_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Gateway App Id
          description: Gateway application ID
      type: object
      required:
        - id
        - url
        - version
      title: KMSInfo
      description: KMS instance information.
    CvmNetworkUrls:
      properties:
        app:
          type: string
          title: App
        instance:
          type: string
          title: Instance
      type: object
      required:
        - app
        - instance
      title: CvmNetworkUrls
      description: Model representing public URLs for a CVM port
    CVMResourceInfo:
      properties:
        instance_type:
          anyOf:
            - type: string
            - type: 'null'
          title: Instance Type
        vcpu:
          anyOf:
            - type: integer
            - type: 'null'
          title: Vcpu
        memory_in_gb:
          anyOf:
            - type: number
            - type: 'null'
          title: Memory In Gb
        disk_in_gb:
          anyOf:
            - type: integer
            - type: 'null'
          title: Disk In Gb
        gpus:
          anyOf:
            - type: integer
            - type: 'null'
          title: Gpus
        compute_billing_price:
          anyOf:
            - type: string
              format: decimal
              description: A monetary value with precise decimal arithmetic
              examples:
                - '19.99'
                - '123.456000'
            - type: 'null'
          title: Compute Billing Price
        billing_period:
          anyOf:
            - $ref: '#/components/schemas/BillingPeriod'
            - type: 'null'
      type: object
      title: CVMResourceInfo
    NodeRef:
      properties:
        object_type:
          type: string
          const: node
          title: Object Type
          description: Fixed value 'node'
          default: node
        id:
          anyOf:
            - type: integer
            - type: 'null'
          title: Id
          description: Teepod numeric ID
        node_id:
          anyOf:
            - type: integer
            - type: 'null'
          title: Node Id
          description: Physical node numeric ID
        name:
          anyOf:
            - type: string
            - type: 'null'
          title: Name
          description: Node display name
        region:
          anyOf:
            - type: string
            - type: 'null'
          title: Region
          description: Region identifier
        device_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Device Id
          description: Device ID
        ppid:
          anyOf:
            - type: string
            - type: 'null'
          title: Ppid
          description: PPID
        status:
          anyOf:
            - $ref: '#/components/schemas/TeepodStatus'
            - type: 'null'
          description: Node status
        version:
          anyOf:
            - type: string
            - type: 'null'
          title: Version
          description: Teepod version
      type: object
      title: NodeRef
      description: Minimal node/teepod reference for embedding in responses.
    CVMOSInfo:
      properties:
        name:
          anyOf:
            - type: string
            - type: 'null'
          title: Name
        version:
          anyOf:
            - type: string
            - type: 'null'
          title: Version
        is_dev:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Is Dev
        os_image_hash:
          anyOf:
            - type: string
            - type: 'null'
          title: Os Image Hash
      type: object
      title: CVMOSInfo
    KmsType:
      type: string
      enum:
        - phala
        - ethereum
        - base
        - legacy
      title: KmsType
    CVMKmsInfo:
      properties:
        chain_id:
          anyOf:
            - type: integer
            - type: 'null'
          title: Chain Id
        dstack_kms_address:
          anyOf:
            - type: string
            - type: 'null'
          title: Dstack Kms Address
        dstack_app_address:
          anyOf:
            - type: string
            - type: 'null'
          title: Dstack App Address
        deployer_address:
          anyOf:
            - type: string
            - type: 'null'
          title: Deployer Address
        rpc_endpoint:
          anyOf:
            - type: string
            - type: 'null'
          title: Rpc Endpoint
        encrypted_env_pubkey:
          anyOf:
            - type: string
            - type: 'null'
          title: Encrypted Env Pubkey
      type: object
      title: CVMKmsInfo
    CVMProgressInfo:
      properties:
        target:
          anyOf:
            - type: string
            - type: 'null'
          title: Target
        started_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Started At
        correlation_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Correlation Id
      type: object
      title: CVMProgressInfo
    CVMGatewayInfo:
      properties:
        base_domain:
          anyOf:
            - type: string
            - type: 'null'
          title: Base Domain
        cname:
          anyOf:
            - type: string
            - type: 'null'
          title: Cname
      type: object
      title: CVMGatewayInfo
    CVMLogUrls:
      properties:
        serial:
          anyOf:
            - type: string
            - type: 'null'
          title: Serial
        stdout:
          anyOf:
            - type: string
            - type: 'null'
          title: Stdout
        stderr:
          anyOf:
            - type: string
            - type: 'null'
          title: Stderr
        container_log_base:
          anyOf:
            - type: string
            - type: 'null'
          title: Container Log Base
      type: object
      title: CVMLogUrls
    WorkspaceRef:
      properties:
        object_type:
          type: string
          const: workspace
          title: Object Type
          description: Fixed value 'workspace'
          default: workspace
        id:
          type: string
          pattern: ^wks_.+
          format: hashid
          title: HashedId[teams]
          description: Hashed workspace ID
          examples:
            - wks_0123abcd
        name:
          type: string
          title: Name
          description: Workspace display name
        slug:
          anyOf:
            - type: string
            - type: 'null'
          title: Slug
          description: URL-safe workspace identifier
        avatar_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Avatar Url
          description: Workspace avatar URL from profile
      type: object
      required:
        - id
        - name
      title: WorkspaceRef
      description: Minimal workspace reference for embedding in responses.
    UserRef:
      properties:
        object_type:
          type: string
          const: user
          title: Object Type
          description: Fixed value 'user'
          default: user
        id:
          anyOf:
            - type: string
              pattern: ^usr_.+
              format: hashid
              title: HashedId[users]
              description: A hashed identifier that maps to an internal database ID
              examples:
                - usr_0123abcd
            - type: 'null'
          title: Id
          description: Hashed user ID
        username:
          anyOf:
            - type: string
            - type: 'null'
          title: Username
          description: Display username
        avatar_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Avatar Url
          description: Gravatar or OAuth provider avatar URL
      type: object
      title: UserRef
      description: Minimal user reference for embedding in responses.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
    BillingPeriod:
      type: string
      enum:
        - skip
        - hourly
        - monthly
      title: BillingPeriod
    TeepodStatus:
      type: string
      enum:
        - ONLINE
        - OFFLINE
        - MAINTENANCE
      title: TeepodStatus
  securitySchemes:
    OAuth2AuthorizationCodeBearer:
      type: oauth2
      flows:
        authorizationCode:
          scopes: {}
          authorizationUrl: ''
          tokenUrl: token
    APIKeyHeader:
      type: apiKey
      in: header
      name: X-API-Key

````