Skip to main content

REST API

CloudRift provides a full REST API for managing instances, clusters, networks, volumes, reservations, and more. You can explore and test API endpoints using either of the interactive documentation tools below:

  • Swagger UI — recommended, with full OpenAPI 3.1 support.
  • RapiDoc — alternative interactive API reference.

All API endpoints support authentication via user JWT token, user API key, or team API key.

Key Capabilities​

Beyond standard instance and cluster management, the API includes:

  • MCP integration — POST /mcp endpoint exposes CloudRift operations as MCP tools for LLM integration (Claude Code, Claude Desktop, etc.).
  • Node metrics — /api/v1/nodes/metrics/list for GPU and MIG instance metrics.
  • Instance GPU metrics — POST /api/v1/instances/metrics for per-instance GPU metrics (utilization, temperature, VRAM, power draw) scoped by the instance's allocated GPU mask.
  • Two-factor authentication — TOTP-based 2FA endpoints for setting up, verifying, and managing two-factor authentication on accounts. See Two-Factor Authentication.
  • Admin user & team management — Endpoints for listing, searching, creating users, and managing teams with financial settings. Supports team invite by email for users who don't yet have an account.
  • Custom recipes — Create and manage recipes for virtual machines and containers at the user or team level.
  • Instance tags — Attach free-form tags at rent time and filter POST /api/v1/instances/list with the ByTags selector (all / any).
  • Opt-in instance credentials — POST /api/v1/instances/list omits instance passwords unless you set mask.with_credentials. See v0.61.0.
  • Saved environments — POST /api/v1/instances/saved-environments/list lists terminated VM disks still within the node's erase grace window; pass reuse_environment_id on rent to re-attach one to a new rental on the same node.
  • NVIDIA driver compatibility: nvidia_kernel_module_support on GPUs, instance types, reservations and quotas tells you which NVIDIA driver flavor (open or proprietary) a VM image needs for that hardware. Renting an incompatible catalog image is rejected up front. See v0.62.1.
  • Renter-scoped networks: the ByRenter selector on POST /api/v1/network/list returns only the networks a rental by a given team or user can use.
  • Unallocated capacity: node info includes unallocated, the free capacity that no allocation holds and that other accounts can rent.
  • Team API key support — /api/v1/auth/me supports team API key authentication in addition to user tokens. Also returns totp_enabled to indicate whether 2FA is active on the account.

Refer to the Swagger UI for the complete endpoint reference.