v1

latestOpenAPI 3.1.02026-07-26102158206.8 KB

CVMs

Provision DStack app

Validates Docker Compose configuration and caches it for 14 days. Returns compose_hash and KMS info for on-chain registration before creation.

post/api/v1/cvms/provision

Request body

namestring required

CVM name (used as hostname): 5-63 chars, must start with letter, can contain letters/numbers/hyphens

instance_typestring nullable

vcpuinteger nullable

memoryinteger nullable

disk_sizeinteger nullable

imagestring nullable

prefer_devboolean nullable

Prefer dev OS image (True) or non-dev OS image (False). When None, auto-selects based on image name or defaults to dev.

teepod_idinteger nullable

regionstring nullable

listedboolean

kms_idstring nullable

kms'phala' | 'ethereum' | 'base' | 'legacy'

nonceinteger nullable

Optional nonce for deterministic app_id generation. When provided, app_id must also be provided. System will verify: app_id == get_create_address(team_wallet, nonce)

app_idstring nullable

Optional app_id for manual specification. Required when nonce is provided. Only works with PHALA KMS.

env_keysstring[]

encrypted_envstring nullable

user_configstring nullable

hugepagesboolean

pin_numaboolean

kms_urlsstring[]

gateway_urlsstring[]

experimental_vpc_server_app_idstring nullable

Response

Provision data with compose_hash for creation

{"stackTrail":"paths:/api/v1/cvms/provision:post:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}