Skip to main content

Virtual Machine

A virtual machine on Hyperstack is deployed within an environment in a region, with hardware spec set by the chosen flavor. These endpoints cover the full VM lifecycle, including deployment, state management, attaching firewalls and storage, snapshotting, and inspecting logs and metrics.

Core


GET

List virtual machines

Returns a list of your existing virtual machines with configuration details.

POST

Create virtual machines

Creates one or more virtual machines with a specified configuration and features.

GET

Retrieve virtual machine details

Retrieves the details of an existing virtual machine by ID.

DEL

Delete virtual machine

Permanently deletes a virtual machine by ID.

GET

Fetch virtual machine name availability

Checks whether a virtual machine name is available.

Lifecycle


GET

Start virtual machine

Initiates the startup of a virtual machine.

GET

Stop virtual machine

Shuts down a virtual machine.

GET

Hard reboot virtual machine

Initiates a hard reboot, simulating a physical power cycle.

GET

Hibernate virtual machine

Saves VM state to disk, deallocates resources, and powers it off.

GET

Restore virtual machine from hibernation

Resumes a hibernated virtual machine to an active state.

Networking & Firewalls


POST

Attach firewalls to VMs

Attaches an existing firewall to one or more virtual machines.

POST

Attach firewalls to a virtual machine

Attaches firewalls to a VM; any firewalls not included are detached.

POST

Add firewall rule to virtual machine

Creates a firewall rule and applies it to a virtual machine.

DEL

Delete firewall rule from virtual machine

Deletes a firewall rule associated with a virtual machine.

Monitoring


GET

List virtual machine events

Retrieves the full events history for a virtual machine.

POST

Request virtual machine logs

Initiates log fetching and returns a request ID to retrieve the logs.

GET

Get virtual machine logs

Retrieves console logs for an active virtual machine using a request ID.

GET

Retrieve virtual machine performance metrics

Retrieves CPU, memory, network, and disk performance metrics for a VM.

Configuration


PUT

Edit virtual machine labels

Adds one or more labels to an existing virtual machine.

POST

Create snapshot from a virtual machine

Creates a snapshot of a virtual machine.

GET

Retrieve virtual machines associated with a contract

Retrieves a list of virtual machines associated with a contract.