Technical Docs

VM Service Documentation

This portal documents the current API surface for provisioning and operating virtual machines. It is structured as technical guides first, with the generated OpenAPI reference available as a second layer when you need exact request and response details.

What this portal covers

The authored pages focus on the VM lifecycle: create a project, inspect provisioning options, create a VM, establish access, connect networking, and recover from backups. The generated API Reference remains the source for complete schemas, parameters, and per-endpoint status codes.

Quickstart

Minimal path from API key to a running virtual machine.

Authentication

Current base URL, API key header, and first authenticated request.

Platform Model

Resource relationships between projects, images, tariffs, configurations, VMs, and backups.

Networking

Private networks, public IP resources, internal addressing, and port forwarding.

Create and Access a VM

Provision a VM with image, tariff, SSH access, and optional public IP behavior.

API Reference

Generated endpoint documentation, schemas, parameters, and cURL snippets.

Recommended reading order

• Start with Quickstart for the shortest working path.

• Read Authentication before wiring the API into a client.

• Use Platform Model and Networking to understand resource boundaries.

• Move to the guide pages when you need a concrete workflow, then open the generated reference for payload details.

Current documentation scope

Billing flows are intentionally excluded from this documentation layer. The remaining balance endpoint stays available in the generated API Reference as a technical resource, but it is not part of the main provisioning guides.