Phala Cloud Documentation — Private AI on TEE

Get CVM details

curl --request GET \
  --url https://cloud-api.phala.com/api/v1/cvms/{cvm_id}

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://cloud-api.phala.com/api/v1/cvms/{cvm_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://cloud-api.phala.com/api/v1/cvms/{cvm_id}"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://cloud-api.phala.com/api/v1/cvms/{cvm_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "id": 123,
  "name": "<string>",
  "status": "<string>",
  "app_id": "<string>",
  "vcpu": 123,
  "memory": 123,
  "disk_size": 123,
  "enabled_ssh_access": true,
  "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": "prj_0123abcd",
  "project_type": "<string>",
  "instance_type": "<string>",
  "public_sysinfo": true,
  "public_logs": true,
  "managed_env": false,
  "dapp_dashboard_url": "<string>",
  "syslog_endpoint": "<string>",
  "kms_info": {
    "id": "kms_0123abcd",
    "url": "<string>",
    "version": "<string>",
    "slug": "<string>",
    "chain_id": 123,
    "kms_contract_address": "<string>",
    "gateway_app_id": "<string>",
    "ca_pubkey": "<string>",
    "k256_pubkey": "<string>"
  },
  "contract_address": "<string>",
  "deployer_address": "<string>",
  "scheduled_delete_at": "2023-11-07T05:31:56Z",
  "public_urls": [
    {
      "app": "<string>",
      "instance": "<string>"
    }
  ],
  "gateway_domain": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

GET

api

cvms

{cvm_id}

Get CVM details

curl --request GET \
  --url https://cloud-api.phala.com/api/v1/cvms/{cvm_id}

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://cloud-api.phala.com/api/v1/cvms/{cvm_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://cloud-api.phala.com/api/v1/cvms/{cvm_id}"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://cloud-api.phala.com/api/v1/cvms/{cvm_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "id": 123,
  "name": "<string>",
  "status": "<string>",
  "app_id": "<string>",
  "vcpu": 123,
  "memory": 123,
  "disk_size": 123,
  "enabled_ssh_access": true,
  "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": "prj_0123abcd",
  "project_type": "<string>",
  "instance_type": "<string>",
  "public_sysinfo": true,
  "public_logs": true,
  "managed_env": false,
  "dapp_dashboard_url": "<string>",
  "syslog_endpoint": "<string>",
  "kms_info": {
    "id": "kms_0123abcd",
    "url": "<string>",
    "version": "<string>",
    "slug": "<string>",
    "chain_id": 123,
    "kms_contract_address": "<string>",
    "gateway_app_id": "<string>",
    "ca_pubkey": "<string>",
    "k256_pubkey": "<string>"
  },
  "contract_address": "<string>",
  "deployer_address": "<string>",
  "scheduled_delete_at": "2023-11-07T05:31:56Z",
  "public_urls": [
    {
      "app": "<string>",
      "instance": "<string>"
    }
  ],
  "gateway_domain": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Path Parameters

cvm_id

string

required

Response

CVM details

CvmBasicInfo
CVMInfoDetail

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

required

CVM 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

enabled_ssh_access

boolean

required

True when SSH access is enabled for this CVM. Today that means the CVM runs a dev OS image, the only image that runs sshd.

teepod_id

integer | null

Node ID (admin only)

teepod

CvmNode · object | null

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

Pattern: ^prj_.+

Example:

"prj_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

managed_env

boolean

default:false

True when guest-side encrypted-env merge is active. Partial env updates preserve other allowed keys; removing a key deletes its value from the CVM.

dapp_dashboard_url

string | null

DApp dashboard URL if applicable

syslog_endpoint

string | null

Syslog streaming endpoint

kms_info

KMSInfo · object | null

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