Skip to main content
GET
List CVMs

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

user_id

Filter by owner (admin only). Use '0' for unassigned.

Allowed value: "0"
teepod_id
integer | null

Filter by node ID (admin only)

Response

List of CVM summaries

hosted
VmInfo · object
required

Mapping from Teepod RPC's VmInfo.

name
string
required
status
string
required
public_urls
CvmNetworkUrls · object[]
required
managed_user
ManagedUser · object | null
node
CvmNode · object | null
listed
boolean
default:false
in_progress
boolean
default:false
dapp_dashboard_url
string | null
syslog_endpoint
string | null
allow_upgrade
boolean
default:false
project_id
string<hashid> | null

A hashed identifier that maps to an internal database ID

Pattern: ^prj_.+
Example:

"prj_0123abcd"

project_type
string | null
billing_period
string | null
kms_info
KMSInfo · object | null

KMS instance information.

contract_address
string | null
deployer_address
string | null
vcpu
integer | null
memory
integer | null
disk_size
integer | null
gateway_domain
string | null