> For the complete documentation index, see [llms.txt](https://docs.vergeos-demo.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.vergeos-demo.com/knowledge-base/automation-api.md). # Automation & API Working with the VergeOS API, automation tasks, Terraform, and integration tooling. * [API Guide](/knowledge-base/automation-api/verge-api-guide.md) — A comprehensive guide to using the VergeOS API, covering authentication, HTTP methods, endpoint conventions, filtering, sorting, error… * [API Helper Script](/knowledge-base/automation-api/api-helper-script.md) — A guide to using the VergeOS yb-api helper script for simplified API interactions, including listing, creating, cloning, and managing… * [API Tables Description](/knowledge-base/automation-api/api-tables-description.md) — 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](/knowledge-base/automation-api/automated-task-example-1.md) — 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](/knowledge-base/automation-api/automated-task-example-webhook.md) — 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](/knowledge-base/automation-api/force-power-off-vm-using-api.md) — 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](/knowledge-base/automation-api/determine-node-where-vm-runs.md) — 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](/knowledge-base/automation-api/terraform-vergeio-provider.md) — Learn how to use the VergeIO Terraform Provider to manage VergeOS resources programmatically. * [VM Advanced Operations API](/knowledge-base/automation-api/vm-advanced-operations.md) — Complete guide to advanced VM operations in VergeOS, including cloning, snapshots, deletion, and troubleshooting * [VM Configuration API](/knowledge-base/automation-api/vm-configuration.md) — Complete guide to modifying VM configurations in VergeOS, including CPU/RAM updates, notes, drive management, and network interface… * [VM Creation API](/knowledge-base/automation-api/vm-creation-api.md) — Complete guide to creating virtual machines in VergeOS, including basic creation, recipe-based configurations, drives, devices, and network… * [VM Lifecycle Management API Overview](/knowledge-base/automation-api/vm-lifecycle-management.md) — Complete REST API guide for virtual machine lifecycle management in VergeOS - create, manage, configure, and delete VMs programmatically * [VM Power Management API](/knowledge-base/automation-api/vm-power-management.md) — Complete guide to managing VM power states in VergeOS, including starting, stopping, rebooting, and monitoring power status --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.vergeos-demo.com/knowledge-base/automation-api.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.