Get CVM details

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

GET /api/v1/cvms/{cvm_id}

Get CVM details

cURL

curl --request GET \
  --url https://cloud-api.phala.com/api/v1/cvms/{cvm_id} \
  --header 'Authorization: Bearer <token>'

200

{
  "id": 123,
  "name": "<string>",
  "status": "<string>",
  "app_id": "<string>",
  "vcpu": 123,
  "memory": 123,
  "disk_size": 123,
  "teepod_id": 123,
  "teepod": {
    "id": 123,
    "name": "<string>",
    "region_identifier": "<string>"
  },
  "in_progress": false,
  "vm_uuid": "<string>",
  "instance_id": "<string>",
  "base_image": "<string>",
  "encrypted_env_pubkey": "<string>",
  "listed": false,
  "project_id": "0123abcd",
  "project_type": "<string>",
  "instance_type": "<string>",
  "public_sysinfo": true,
  "public_logs": true,
  "dapp_dashboard_url": "<string>",
  "syslog_endpoint": "<string>",
  "kms_info": {
    "id": "<string>",
    "url": "<string>",
    "version": "<string>",
    "slug": "<string>",
    "chain_id": 123,
    "kms_contract_address": "<string>",
    "gateway_app_id": "<string>"
  },
  "contract_address": "<string>",
  "deployer_address": "<string>",
  "scheduled_delete_at": "2023-11-07T05:31:56Z",
  "public_urls": [
    {
      "app": "<string>",
      "instance": "<string>"
    }
  ],
  "gateway_domain": "<string>"
}

Authorizations

OAuth2AuthorizationCodeBearerAPIKeyHeader

Authorization · string · header · required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

cvm_id · string · required

Response

200

application/json

CVM details

CvmBasicInfo

CVMInfoDetail

Detailed CVM information returned by GET /cvms/{cvm_id}.

id · integer · required

Internal CVM database ID

name · string · required

RFC 1123 compliant CVM name

status · string · required

Current status: running, stopped, starting, etc.

app_id · string · required

Unique application identifier

vcpu · integer · required

Allocated vCPU count

memory · integer · required

Allocated memory in MB

disk_size · integer · required

Allocated disk size in GB

teepod_id · integer | null

Node ID (admin only)

teepod · CvmNode · object

Node metadata

Show child attributes

in_progress · boolean · default: false

True if an operation is currently executing

vm_uuid · string | null

VM instance UUID on the node

instance_id · string | null

Public instance identifier

base_image · string | null

OS image name

encrypted_env_pubkey · string | null

Public key for encrypting env vars

listed · boolean · default: false

True if publicly listed

project_id · string<hashid> | null

A hashed identifier that maps to an internal database ID

Example:

"0123abcd"

project_type · string | null

Project provision type

instance_type · string | null

Instance type identifier

public_sysinfo · boolean | null

Expose system info publicly

public_logs · boolean | null

Expose logs publicly

dapp_dashboard_url · string | null

DApp dashboard URL if applicable

syslog_endpoint · string | null

Syslog streaming endpoint

kms_info · KMSInfo · object

KMS configuration

Show child attributes

contract_address · string | null

On-chain contract address

deployer_address · string | null

Deployer wallet address

scheduled_delete_at · string<date-time> | null

Auto-delete timestamp (UTC)

public_urls · CvmNetworkUrls · object[] | null

Exposed service URLs

Show child attributes

gateway_domain · string | null

Gateway base domain