Create a test vm.

post

https://api.replicated.com/vendor/v3/vm

Required RBAC Policy: kots/vm/create

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

DryRun

boolean

Body Params

anthropic_api_key

string

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

count

int64

disk_gib

int64

distribution

string

instance_type

string

name

string

network_id

string

network_policy

string

overlayfs

boolean

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

public_keys

array of strings

public_keys

rbac_policy_id

string

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_key

string

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.

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

201CreateVMResponse contains the response to create a vm

400CreateVMErrorResponse contains error information

401Return if the caller is not authorized

403Returned if the caller does not have the needed permission

404Returned on resource not found