Phala Cloud Documentation — Private AI on TEE

Get app details

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

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://cloud-api.phala.com/api/v1/apps/{app_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/apps/{app_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/apps/{app_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": "prj_0123abcd",
  "name": "<string>",
  "app_id": "<string>",
  "created_at": "<string>",
  "enabled_guest_agent_access": true,
  "kms_type": "<string>",
  "app_provision_type": "<string>",
  "app_icon_url": "<string>",
  "profile": {
    "display_name": "<string>",
    "avatar_url": "<string>",
    "description": "<string>",
    "custom_domain": "<string>"
  },
  "current_cvm": {
    "vm_uuid": "<string>",
    "app_id": "<string>",
    "status": "<string>",
    "vcpu": 123,
    "memory": 123,
    "disk_size": 123,
    "teepod_id": 123,
    "teepod_name": "<string>",
    "region_identifier": "<string>",
    "kms_type": "<string>",
    "instance_type": "<string>",
    "enabled_ssh_access": true,
    "name": "",
    "listed": true,
    "base_image": "<string>",
    "kms_slug": "<string>",
    "kms_id": "kms_0123abcd",
    "kms_contract_id": "kc_0123abcd",
    "instance_id": "<string>",
    "machine_info": {
      "vcpu": 123,
      "memory": 123,
      "disk_size": 123,
      "gpu_count": 123
    },
    "updated_at": "2023-11-07T05:31:56Z"
  },
  "cvms": [
    {
      "vm_uuid": "<string>",
      "app_id": "<string>",
      "status": "<string>",
      "vcpu": 123,
      "memory": 123,
      "disk_size": 123,
      "teepod_id": 123,
      "teepod_name": "<string>",
      "region_identifier": "<string>",
      "kms_type": "<string>",
      "instance_type": "<string>",
      "enabled_ssh_access": true,
      "name": "",
      "listed": true,
      "base_image": "<string>",
      "kms_slug": "<string>",
      "kms_id": "kms_0123abcd",
      "kms_contract_id": "kc_0123abcd",
      "instance_id": "<string>",
      "machine_info": {
        "vcpu": 123,
        "memory": 123,
        "disk_size": 123,
        "gpu_count": 123
      },
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "cvm_count": 0,
  "team_slug": "<string>",
  "team_name": "<string>"
}

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

GET

api

apps

{app_id}

Get app details

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

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://cloud-api.phala.com/api/v1/apps/{app_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/apps/{app_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/apps/{app_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": "prj_0123abcd",
  "name": "<string>",
  "app_id": "<string>",
  "created_at": "<string>",
  "enabled_guest_agent_access": true,
  "kms_type": "<string>",
  "app_provision_type": "<string>",
  "app_icon_url": "<string>",
  "profile": {
    "display_name": "<string>",
    "avatar_url": "<string>",
    "description": "<string>",
    "custom_domain": "<string>"
  },
  "current_cvm": {
    "vm_uuid": "<string>",
    "app_id": "<string>",
    "status": "<string>",
    "vcpu": 123,
    "memory": 123,
    "disk_size": 123,
    "teepod_id": 123,
    "teepod_name": "<string>",
    "region_identifier": "<string>",
    "kms_type": "<string>",
    "instance_type": "<string>",
    "enabled_ssh_access": true,
    "name": "",
    "listed": true,
    "base_image": "<string>",
    "kms_slug": "<string>",
    "kms_id": "kms_0123abcd",
    "kms_contract_id": "kc_0123abcd",
    "instance_id": "<string>",
    "machine_info": {
      "vcpu": 123,
      "memory": 123,
      "disk_size": 123,
      "gpu_count": 123
    },
    "updated_at": "2023-11-07T05:31:56Z"
  },
  "cvms": [
    {
      "vm_uuid": "<string>",
      "app_id": "<string>",
      "status": "<string>",
      "vcpu": 123,
      "memory": 123,
      "disk_size": 123,
      "teepod_id": 123,
      "teepod_name": "<string>",
      "region_identifier": "<string>",
      "kms_type": "<string>",
      "instance_type": "<string>",
      "enabled_ssh_access": true,
      "name": "",
      "listed": true,
      "base_image": "<string>",
      "kms_slug": "<string>",
      "kms_id": "kms_0123abcd",
      "kms_contract_id": "kc_0123abcd",
      "instance_id": "<string>",
      "machine_info": {
        "vcpu": 123,
        "memory": 123,
        "disk_size": 123,
        "gpu_count": 123
      },
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "cvm_count": 0,
  "team_slug": "<string>",
  "team_name": "<string>"
}

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

Path Parameters

app_id

string

required

Hex app identifier

Response

App details with CVM info

DstackAppFullResponse
DstackAppFullResponse

string<hashid>

required

A hashed identifier that maps to an internal database ID

Pattern: ^prj_.+

Example:

"prj_0123abcd"

name

string

required

app_id

string

required

created_at

string

required

enabled_guest_agent_access

boolean

required

Stored guest agent access choice. False means port 8090 is restricted to Phala Cloud. This is the requested value, not the mode a node reports.

kms_type

string

required

app_provision_type

string | null

app_icon_url

string | null

profile

ProfileGetResponse · object | null

Response model for entity profile - only public display data.

Show child attributes

current_cvm

CvmBasicInfo · object | null

Show child attributes

cvms

CvmBasicInfo · object[]

Show child attributes

cvm_count

integer

default:0

team_slug

string | null

team_name

string | null