Skip to main content

Documentation Index

Fetch the complete documentation index at: https://vmarea.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

VMArea is a cloud hosting platform that gives you on-demand virtual machines, private networks, firewalls, and associated billing tooling — all controlled through a straightforward HTTP API.

​
What the API does

The VMArea Public API lets you programmatically:
  • Provision and manage virtual machines — create, start, stop, restart, rebuild, resize, and delete VMs.
  • Run lifecycle actions — password reset, snapshots, backups, and snapshot/backup restore.
  • Manage private networks — create SDN networks and attach or detach VMs.
  • Manage firewalls — define inbound/outbound rules and bind them to VMs.
  • Manage SSH keys — store and reference public keys during VM creation.
  • Read billing data — wallet balance, invoices, and bandwidth usage.
  • Subscribe to webhooks — receive real-time event notifications to your own HTTPS endpoint.
  • Read catalog data — available plans, regions, and OS templates.

​
What it is not

The API does not expose the underlying hypervisor directly. You work with VMArea resources (VMs, networks, firewalls) — the platform handles infrastructure scheduling and lifecycle management on your behalf.

​
Who it is for

The API is designed for engineers automating VM workflows: infrastructure-as-code pipelines, internal dashboards, reseller integrations, or any tooling that needs to provision and control VMs without a browser.

​
Next steps

Quickstart

Make your first API call in under five minutes.

API reference

Full endpoint and schema documentation.