Skip to main content
GET
/
api
/
v1
/
apps
/
{app_id}
Get app details
curl --request GET \
  --url https://cloud-api.phala.com/api/v1/apps/{app_id}
{
  "id": "<string>",
  "name": "<string>",
  "app_id": "<string>",
  "created_at": "<string>",
  "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>",
    "name": "",
    "listed": true,
    "base_image": "<string>",
    "kms_slug": "<string>",
    "kms_id": "<string>",
    "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>",
      "name": "",
      "listed": true,
      "base_image": "<string>",
      "kms_slug": "<string>",
      "kms_id": "<string>",
      "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>"
}

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.

Path Parameters

​
app_id
string
required

Hex app identifier

Response

App details with CVM info

​
id
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
​
kms_type
string
required
​
app_provision_type
string | null
​
app_icon_url
string | null
​
profile
ProfileGetResponse · object

Response model for entity profile - only public display data.

​
current_cvm
CvmBasicInfo · object
​
cvms
CvmBasicInfo · object[]
​
cvm_count
integer
default:0
​
team_slug
string | null
​
team_name
string | null