Create a new instance under an existing app
curl --request POST \
--url https://cloud-api.phala.com/api/v1/apps/{app_id}/instances \
--header 'Content-Type: application/json' \
--data '
{
"node": "<string>",
"os_image": "<string>",
"encrypted_env": "<string>",
"compose_hash": "<string>",
"docker_compose_file": "<string>",
"pre_launch_script": "<string>",
"name": "<string>",
"token": "<string>",
"transaction_hash": "<string>"
}
'import requests
url = "https://cloud-api.phala.com/api/v1/apps/{app_id}/instances"
payload = {
"node": "<string>",
"os_image": "<string>",
"encrypted_env": "<string>",
"compose_hash": "<string>",
"docker_compose_file": "<string>",
"pre_launch_script": "<string>",
"name": "<string>",
"token": "<string>",
"transaction_hash": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
node: '<string>',
os_image: '<string>',
encrypted_env: '<string>',
compose_hash: '<string>',
docker_compose_file: '<string>',
pre_launch_script: '<string>',
name: '<string>',
token: '<string>',
transaction_hash: '<string>'
})
};
fetch('https://cloud-api.phala.com/api/v1/apps/{app_id}/instances', 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}/instances",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'node' => '<string>',
'os_image' => '<string>',
'encrypted_env' => '<string>',
'compose_hash' => '<string>',
'docker_compose_file' => '<string>',
'pre_launch_script' => '<string>',
'name' => '<string>',
'token' => '<string>',
'transaction_hash' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://cloud-api.phala.com/api/v1/apps/{app_id}/instances"
payload := strings.NewReader("{\n \"node\": \"<string>\",\n \"os_image\": \"<string>\",\n \"encrypted_env\": \"<string>\",\n \"compose_hash\": \"<string>\",\n \"docker_compose_file\": \"<string>\",\n \"pre_launch_script\": \"<string>\",\n \"name\": \"<string>\",\n \"token\": \"<string>\",\n \"transaction_hash\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://cloud-api.phala.com/api/v1/apps/{app_id}/instances")
.header("Content-Type", "application/json")
.body("{\n \"node\": \"<string>\",\n \"os_image\": \"<string>\",\n \"encrypted_env\": \"<string>\",\n \"compose_hash\": \"<string>\",\n \"docker_compose_file\": \"<string>\",\n \"pre_launch_script\": \"<string>\",\n \"name\": \"<string>\",\n \"token\": \"<string>\",\n \"transaction_hash\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://cloud-api.phala.com/api/v1/apps/{app_id}/instances")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"node\": \"<string>\",\n \"os_image\": \"<string>\",\n \"encrypted_env\": \"<string>\",\n \"compose_hash\": \"<string>\",\n \"docker_compose_file\": \"<string>\",\n \"pre_launch_script\": \"<string>\",\n \"name\": \"<string>\",\n \"token\": \"<string>\",\n \"transaction_hash\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": 123,
"name": "<string>",
"status": "<string>",
"teepod_id": 123,
"app_id": "<string>",
"vcpu": 123,
"memory": 123,
"disk_size": 123,
"created_at": "2023-11-07T05:31:56Z",
"teepod": {
"id": 123,
"name": "<string>"
},
"user_id": 123,
"vm_uuid": "<string>",
"instance_id": "<string>",
"app_url": "<string>",
"base_image": "<string>",
"manifest_version": 123,
"version": "<string>",
"runner": "<string>",
"docker_compose_file": "<string>",
"features": [
"<string>"
],
"encrypted_env_pubkey": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Apps
Create a new instance under an existing app
Deploy a new CVM instance under an existing app, optionally with a new Docker Compose file. For on-chain KMS apps, this uses a two-phase flow: the first request returns HTTP 465 with a commit token; after registering the compose hash on-chain, the second request commits with the token and transaction hash.
POST
/
api
/
v1
/
apps
/
{app_id}
/
instances
Create a new instance under an existing app
curl --request POST \
--url https://cloud-api.phala.com/api/v1/apps/{app_id}/instances \
--header 'Content-Type: application/json' \
--data '
{
"node": "<string>",
"os_image": "<string>",
"encrypted_env": "<string>",
"compose_hash": "<string>",
"docker_compose_file": "<string>",
"pre_launch_script": "<string>",
"name": "<string>",
"token": "<string>",
"transaction_hash": "<string>"
}
'import requests
url = "https://cloud-api.phala.com/api/v1/apps/{app_id}/instances"
payload = {
"node": "<string>",
"os_image": "<string>",
"encrypted_env": "<string>",
"compose_hash": "<string>",
"docker_compose_file": "<string>",
"pre_launch_script": "<string>",
"name": "<string>",
"token": "<string>",
"transaction_hash": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
node: '<string>',
os_image: '<string>',
encrypted_env: '<string>',
compose_hash: '<string>',
docker_compose_file: '<string>',
pre_launch_script: '<string>',
name: '<string>',
token: '<string>',
transaction_hash: '<string>'
})
};
fetch('https://cloud-api.phala.com/api/v1/apps/{app_id}/instances', 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}/instances",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'node' => '<string>',
'os_image' => '<string>',
'encrypted_env' => '<string>',
'compose_hash' => '<string>',
'docker_compose_file' => '<string>',
'pre_launch_script' => '<string>',
'name' => '<string>',
'token' => '<string>',
'transaction_hash' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://cloud-api.phala.com/api/v1/apps/{app_id}/instances"
payload := strings.NewReader("{\n \"node\": \"<string>\",\n \"os_image\": \"<string>\",\n \"encrypted_env\": \"<string>\",\n \"compose_hash\": \"<string>\",\n \"docker_compose_file\": \"<string>\",\n \"pre_launch_script\": \"<string>\",\n \"name\": \"<string>\",\n \"token\": \"<string>\",\n \"transaction_hash\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://cloud-api.phala.com/api/v1/apps/{app_id}/instances")
.header("Content-Type", "application/json")
.body("{\n \"node\": \"<string>\",\n \"os_image\": \"<string>\",\n \"encrypted_env\": \"<string>\",\n \"compose_hash\": \"<string>\",\n \"docker_compose_file\": \"<string>\",\n \"pre_launch_script\": \"<string>\",\n \"name\": \"<string>\",\n \"token\": \"<string>\",\n \"transaction_hash\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://cloud-api.phala.com/api/v1/apps/{app_id}/instances")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"node\": \"<string>\",\n \"os_image\": \"<string>\",\n \"encrypted_env\": \"<string>\",\n \"compose_hash\": \"<string>\",\n \"docker_compose_file\": \"<string>\",\n \"pre_launch_script\": \"<string>\",\n \"name\": \"<string>\",\n \"token\": \"<string>\",\n \"transaction_hash\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": 123,
"name": "<string>",
"status": "<string>",
"teepod_id": 123,
"app_id": "<string>",
"vcpu": 123,
"memory": 123,
"disk_size": 123,
"created_at": "2023-11-07T05:31:56Z",
"teepod": {
"id": 123,
"name": "<string>"
},
"user_id": 123,
"vm_uuid": "<string>",
"instance_id": "<string>",
"app_url": "<string>",
"base_image": "<string>",
"manifest_version": 123,
"version": "<string>",
"runner": "<string>",
"docker_compose_file": "<string>",
"features": [
"<string>"
],
"encrypted_env_pubkey": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Path Parameters
Hex app identifier
Body
application/json
Request model for creating a new instance under an existing app.
Inherits node, os_image, encrypted_env, compose_hash and their validators from ReplicateRequest.
Physical node name
Minimum string length:
1Target OS image name or slug
New encrypted env blob (hex). Required when the source CVM has managed_env enabled.
Explicit compose hash to replicate. Required when the source app has multiple live instances.
New Docker Compose YAML content
New pre-launch script content
Custom CVM name for the new instance
Commit token returned by a prior prepare-only request. When set, this request commits the previously-prepared instance instead of preparing a new one.
On-chain transaction hash proving compose-hash registration. Use 'already-registered' (or omit) when the hash was registered earlier.
Response
Instance created
Show child attributes
Show child attributes
Was this page helpful?