Get app details
curl --request GET \
--url https://cloud-api.phala.com/api/v1/apps/{app_id}import requests
url = "https://cloud-api.phala.com/api/v1/apps/{app_id}"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://cloud-api.phala.com/api/v1/apps/{app_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?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))
}HttpResponse<String> response = Unirest.get("https://cloud-api.phala.com/api/v1/apps/{app_id}")
.asString();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": "<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>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Apps
Get app details
Returns app metadata and current CVM configuration. Response schema varies by API version.
GET
/
api
/
v1
/
apps
/
{app_id}
Get app details
curl --request GET \
--url https://cloud-api.phala.com/api/v1/apps/{app_id}import requests
url = "https://cloud-api.phala.com/api/v1/apps/{app_id}"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://cloud-api.phala.com/api/v1/apps/{app_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?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))
}HttpResponse<String> response = Unirest.get("https://cloud-api.phala.com/api/v1/apps/{app_id}")
.asString();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": "<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>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Path Parameters
Hex app identifier
Response
App details with CVM info
- DstackAppFullResponse
- DstackAppMinimalResponse
- DstackAppFullResponse
- DstackAppMinimalResponse
A hashed identifier that maps to an internal database ID
Pattern:
^prj_.+Example:
"prj_0123abcd"
Response model for entity profile - only public display data.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Was this page helpful?
⌘I

