Skip to main content
POST
Reimage a VM
Reimage erases the VM’s disk. Copy anything you need off the VM first. For the full flow, see Reimage a VM.

Authorizations

Authorization
string
header
required

Create an organization API key in Account Settings > Developer. Do not send this key to the Kubernetes API server.

Path Parameters

node_id
string<uuid>
required

The VM's node_id from the reservation's VM list.

vm_id
string<uuid>
required

The VM's id from the reservation's VM list.

Body

application/json
disk_id
string<uuid>
required

A disk from GET /v1/orchestrator/disks. Use one of your organization's disks or a disk Ornn provides.

Response

Reimage accepted. The body is the VM, now provisioning from the new disk.

id
string<uuid>
required

VM id. Reboot a VM and reimage take this ID with its node_id. The host reboot and hard reset route takes a node ID, not this ID.

node_id
string<uuid>
required

The host node running the VM.

reservation_id
string<uuid>
required
status
string
required

provisioning, running, failed, or deleting. Treat any other value as not ready.

stages
object[]
required

Customer launch progress for the latest provision, in order.

gpu_count
integer
required
created_at
string<date-time>
required
operation
string | null

The latest operation, provision, destroy, or reboot. A VM stays running during a reboot.

operation_id
string<uuid> | null
operation_status
string | null

queued, running, succeeded, or failed.

operation_started_at
string<date-time> | null
operation_completed_at
string<date-time> | null
failure
null | object

Present when the VM or its latest operation failed. code is virtual_machine_provision_failed, virtual_machine_cleanup_failed, or virtual_machine_reboot_failed.

ready_at
string<date-time> | null

When the VM first became ready. Set only while running.

hostname
string

The VM's hostname. Not an SSH address.

ip
string | null

SSH address. Present while provisioning or running.

tenant_username
string | null

Linux login, tenant. Present only while running.

port
integer | null

SSH port. Present while provisioning or running. Do not assume 22.

disk_id
string<uuid> | null
destroy_at
string<date-time> | null