Phala Cloud Documentation — Private AI on TEE

Get revision detail

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

const options = {method: 'GET'};

fetch('https://cloud-api.phala.com/api/v1/apps/{app_id}/revisions/{revision_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}/revisions/{revision_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}/revisions/{revision_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}/revisions/{revision_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

{
  "revision_id": "<string>",
  "app_id": "<string>",
  "vm_uuid": "<string>",
  "compose_hash": "<string>",
  "compose_file": {},
  "encrypted_env": "<string>",
  "user_config": "<string>",
  "created_at": "<string>",
  "trace_id": "<string>",
  "operation_type": "<string>",
  "triggered_by": {
    "object_type": "user",
    "id": "usr_0123abcd",
    "username": "<string>",
    "avatar_url": "<string>"
  },
  "cvm": {
    "vm_uuid": "<string>",
    "object_type": "cvm",
    "app_id": "<string>",
    "name": "<string>"
  },
  "workspace": {
    "id": "wks_0123abcd",
    "name": "<string>",
    "object_type": "workspace",
    "slug": "<string>",
    "avatar_url": "<string>"
  },
  "oidc_provenance": {
    "repository": "<string>",
    "ref": "<string>",
    "sha": "<string>",
    "actor": "<string>",
    "workflow_ref": "<string>",
    "run_id": "<string>",
    "event_name": "<string>"
  }
}

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

GET

api

apps

{app_id}

revisions

{revision_id}

Get revision detail

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

const options = {method: 'GET'};

fetch('https://cloud-api.phala.com/api/v1/apps/{app_id}/revisions/{revision_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}/revisions/{revision_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}/revisions/{revision_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}/revisions/{revision_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

{
  "revision_id": "<string>",
  "app_id": "<string>",
  "vm_uuid": "<string>",
  "compose_hash": "<string>",
  "compose_file": {},
  "encrypted_env": "<string>",
  "user_config": "<string>",
  "created_at": "<string>",
  "trace_id": "<string>",
  "operation_type": "<string>",
  "triggered_by": {
    "object_type": "user",
    "id": "usr_0123abcd",
    "username": "<string>",
    "avatar_url": "<string>"
  },
  "cvm": {
    "vm_uuid": "<string>",
    "object_type": "cvm",
    "app_id": "<string>",
    "name": "<string>"
  },
  "workspace": {
    "id": "wks_0123abcd",
    "name": "<string>",
    "object_type": "workspace",
    "slug": "<string>",
    "avatar_url": "<string>"
  },
  "oidc_provenance": {
    "repository": "<string>",
    "ref": "<string>",
    "sha": "<string>",
    "actor": "<string>",
    "workflow_ref": "<string>",
    "run_id": "<string>",
    "event_name": "<string>"
  }
}

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

Path Parameters

app_id

string

required

Hex app identifier

revision_id

string

required

External AppRevisionId (prefix 'rev_'). Fully prefixed string required; bare payloads and raw integers are rejected.

Example:

"rev_0123abcd"

Query Parameters

raw_compose_file

boolean

default:false

Return compose_file as string instead of dict

Response

Revision detail with compose file

Full revision detail with configuration data.

revision_id

string

required

Revision record identifier (hashid of snowflake_id)

app_id

string

required

Hex app identifier

vm_uuid

string

required

CVM UUID

compose_hash

string

required

SHA-256 hash of compose file

compose_file

required

Docker compose content (dict or raw string)

encrypted_env

string

required

Hex-encoded encrypted environment variables

user_config

string

required

JSON user configuration string

created_at

string

required

Revision timestamp (ISO 8601)

trace_id

string | null

required

Request trace ID for debugging

operation_type

string

required

Operation: deploy, update, restart, etc.

triggered_by

UserRef · object | null

User who triggered the operation

Show child attributes

cvm

CvmRef · object | null

CVM reference

Show child attributes

workspace

WorkspaceRef · object | null

Workspace reference

Show child attributes

oidc_provenance

OidcProvenance · object | null

GitHub Actions OIDC provenance when this deploy used OIDC

Show child attributes