apps29

channelReleases7

channels10

clusterAddons3

clusters19

cmx6

customers19

customHostnames5

enterprisePortal43

externalRegistries7

instances11

networks3

notifications13

policy5

registry4

releases14

supportBundle15

team10

telemetry3

user3

vmAddons1

vms9

vms

Create a test vm.

Changed on Nov 3, 2026

Required RBAC Policy: kots/vm/create

post/vm

Request

Base URL
https://api.replicated.com/vendor/v3
URL
https://api.replicated.com/vendor/v3/vm
Auth
API key in header Authorization

Query parameters

dry-runboolean

Request body

anthropic_api_keystring

OpenClaw VM credentials — required when Distribution == "openclaw"

countinteger

disk_gibinteger

distributionstring

instance_typestring

namestring

network_idstring

network_policystring

overlayfsboolean

Overlayfs enables overlay filesystem management for the VM rootfs on the host. Gated by the cmx_overlayfs feature flag.

public_keysstring[]

rbac_policy_idstring

RBACPolicyID is the ID of an existing RBAC policy to assign to the VM. When set, OIDC client credentials are generated and injected into the VM via the Firecracker metadata service (MMDS), enabling the replicated CLI inside the VM to authenticate with vendor-api automatically.

replicated_api_keystring

ReplicatedAPIKey is a vendor-api token for the replicated CLI inside the VM. Required for openclaw VMs when rbac_policy_id is not set. Mutually exclusive with rbac_policy_id — exactly one must be provided for openclaw VMs.

telegram_bot_tokenstring

telegram_user_idstring

ttlstring

versionstring

Response

CreateVMDryRunResponse contains the response to a dry run of creating a vm

total_costinteger