v1

latestOpenAPI 3.1.02026-07-26102158206.8 KB

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

Path parameters

app_idstring required

Hex app identifier

Request body

teepod_idinteger nullable

Target node ID (deprecated, use node_id)

node_idinteger nullable

Target node ID for the replica

encrypted_envstring nullable

New encrypted env blob (hex)

compose_hashstring nullable

Explicit compose hash to replicate. Required when the source app has multiple live instances.

docker_compose_filestring nullable

New Docker Compose YAML content

pre_launch_scriptstring nullable

New pre-launch script content

tokenstring nullable

Commit token returned by a prior prepare-only request. When set, this request commits the previously-prepared instance instead of preparing a new one.

transaction_hashstring nullable

On-chain transaction hash proving compose-hash registration. Use 'already-registered' (or omit) when the hash was registered earlier.

Response

Instance created

idinteger required

namestring required

statusstring required

teepod_idinteger required

user_idinteger nullable

app_idstring required

vm_uuidstring nullable

instance_idstring nullable

app_urlstring nullable

base_imagestring nullable

vcpuinteger required

memoryinteger required

disk_sizeinteger required

manifest_versioninteger nullable

versionstring nullable

runnerstring nullable

docker_compose_filestring nullable

featuresstring[] nullable

created_atstring date-time required

encrypted_env_pubkeystring nullable