Automation & API

Working with the VergeOS API, automation tasks, Terraform, and integration tooling.

• API Guide — A comprehensive guide to using the VergeOS API, covering authentication, HTTP methods, endpoint conventions, filtering, sorting, error…
• API Helper Script — A guide to using the VergeOS yb-api helper script for simplified API interactions, including listing, creating, cloning, and managing…
• API Tables Description — A reference of all VergeOS API tables with brief descriptions, covering resources such as billing, catalogs, clusters, certificates…
• Automated Task Example - Power on/off VMs Automatically as Needed — Configuration example of an automated task that conserves resources by powering on VMs when a designated user logs in, powering them off on…
• Automated Task Example - Send Slack Channel and Email Alerts Upon a Sync Error — Automation example showing specific configuration to send an email alert and a Slack channel notification if a sync error is encountered.
• Force Power Off a VM Using the API — Step-by-step instructions for force powering off a non-responsive virtual machine using the VergeOS API and Swagger interface, including…
• Settings that Influence VM Node Selection — Explains VM options that control which node a VM runs on, including HA group affinity and anti-affinity, preferred node, preferred cluster…
• Terraform VergeIO Provider — Learn how to use the VergeIO Terraform Provider to manage VergeOS resources programmatically.
• VM Advanced Operations API — Complete guide to advanced VM operations in VergeOS, including cloning, snapshots, deletion, and troubleshooting
• VM Configuration API — Complete guide to modifying VM configurations in VergeOS, including CPU/RAM updates, notes, drive management, and network interface…
• VM Creation API — Complete guide to creating virtual machines in VergeOS, including basic creation, recipe-based configurations, drives, devices, and network…
• VM Lifecycle Management API Overview — Complete REST API guide for virtual machine lifecycle management in VergeOS - create, manage, configure, and delete VMs programmatically
• VM Power Management API — Complete guide to managing VM power states in VergeOS, including starting, stopping, rebooting, and monitoring power status