Skip to main content
All CVM query functions accept a CVM identifier. The SDK auto-detects the format:
FormatExample
Namemy-app
UUID550e8400-e29b-41d4-a716-446655440000
App ID0x1234abcd... (40 hex chars, optional 0x prefix)
Instance IDinstance-abc123

​
getCvmInfo

GET /cvms/{cvmId} Returns full CVM details including configuration, status, and metadata. Parameters:
FieldTypeRequiredDescription
idstringYesCVM identifier (any format above)
Returns: CvmInfo — version-aware response with CVM details. Example: 
const cvm = await client.getCvmInfo({ id: "my-app" });
console.log(cvm.name, cvm.status);

​
getCvmList

GET /cvms/paginated Returns a paginated list of CVMs. Parameters:
FieldTypeRequiredDescription
pagenumberNoPage number
page_sizenumberNoItems per page
node_idnumberNoFilter by node
user_idstringNoFilter by user
Returns: Paginated list of CVM objects. Example: 
const list = await client.getCvmList({ page: 1, page_size: 10 });

​
getCvmState

GET /cvms/{cvmId}/state Returns the current state of a CVM (non-streaming, immediate response). Parameters:
FieldTypeRequiredDescription
idstringYesCVM identifier
Returns: CvmState
FieldTypeDescription
idstringCVM ID
instance_idstringInstance ID
namestringCVM name
statusstringCurrent status
uptimestring?Uptime duration
boot_progressstring?Boot progress percentage
boot_errorstring?Boot error if failed
Example: 
const state = await client.getCvmState({ id: "my-app" });
console.log(state.status); // "running", "stopped", etc.

​
getCvmStats

GET /cvms/{cvmId}/stats Returns system information and resource usage for a CVM. Parameters:
FieldTypeRequiredDescription
idstringYesCVM identifier
Returns: CvmSystemInfo
FieldTypeDescription
is_onlinebooleanWhether CVM is reachable
is_publicbooleanWhether stats are public
sysinfoobject?CPU, memory, disk usage
statusstring?Current status
boot_progressstring?Boot progress
Example: 
const stats = await client.getCvmStats({ id: "my-app" });
if (stats.sysinfo) {
  console.log(`CPU: ${stats.sysinfo.cpu_usage}%`);
}

​
getCvmNetwork

GET /cvms/{cvmId}/network Returns network information including public URLs and internal IP. Parameters:
FieldTypeRequiredDescription
idstringYesCVM identifier
Returns: CvmNetwork
FieldTypeDescription
is_onlinebooleanWhether CVM is reachable
internal_ipstring?WireGuard internal IP
public_urlsarray?Public URL mappings
Example: 
const net = await client.getCvmNetwork({ id: "my-app" });
console.log(net.public_urls);

​
getCvmContainersStats

GET /cvms/{cvmId}/composition Returns container-level information including running state and log endpoints. Parameters:
FieldTypeRequiredDescription
idstringYesCVM identifier
Returns: CvmContainersStats
FieldTypeDescription
is_onlinebooleanWhether CVM is reachable
docker_compose_filestring?Active compose YAML
containersarray?Container info (id, names, image, state, status, log_endpoint)
Example: 
const stats = await client.getCvmContainersStats({ id: "my-app" });
stats.containers?.forEach(c => console.log(c.names, c.state));

​
getCvmAttestation

GET /cvms/{cvmId}/attestation Returns TEE attestation details including certificates and TCB info. Parameters:
FieldTypeRequiredDescription
idstringYesCVM identifier
Returns: CvmAttestation
FieldTypeDescription
is_onlinebooleanWhether CVM is reachable
app_certificatesarray?TLS certificates with attestation
tcb_infoobject?TCB measurements (mrtd, rtmr0-3, event_log, app_compose hash)
Example: 
const att = await client.getCvmAttestation({ id: "my-app" });
console.log(att.tcb_info?.app_compose);

​
getCvmDockerCompose

GET /cvms/{cvmId}/docker-compose Returns the raw docker-compose configuration as a string. Parameters:
FieldTypeRequiredDescription
idstringYesCVM identifier
Returns: string — raw docker-compose YAML content. Example: 
const compose = await client.getCvmDockerCompose({ id: "my-app" });
console.log(compose);

​
getCvmComposeFile

GET /cvms/{cvmId}/compose_file Returns the full compose file object with utility methods for hashing. Parameters:
FieldTypeRequiredDescription
idstringYesCVM identifier
Returns: LooseAppCompose — compose file object with getHash() and toString() methods. Example: 
const compose = await client.getCvmComposeFile({ id: "my-app" });
console.log(compose.docker_compose_file);
console.log(compose.getHash());

​
getCvmPreLaunchScript

GET /cvms/{cvmId}/pre-launch-script Returns the pre-launch script content. Parameters:
FieldTypeRequiredDescription
idstringYesCVM identifier
Returns: string — pre-launch script content.

​
getCvmStatusBatch

GET /cvms/status/batch Returns the status of multiple CVMs in a single request. Parameters:
FieldTypeRequiredDescription
idsstring[]YesArray of CVM IDs
Returns: GetCvmStatusBatchResponse
FieldTypeDescription
statusesCvmStatus[]Status for each requested CVM
Example: 
const batch = await client.getCvmStatusBatch({ ids: ["id-1", "id-2"] });
batch.statuses.forEach(s => console.log(s.id, s.status));

​
getCvmUserConfig

GET /cvms/{cvmId}/user-config Returns the user-level configuration for a CVM. Parameters:
FieldTypeRequiredDescription
idstringYesCVM identifier
Returns: CvmUserConfig — user configuration details.