Unraid API icon

Unraid API

Interact with the Unraid API

VM → Force Stop

AI-generated

Summary

Force-stops the VM identified by its required VM ID through the Unraid API. Returns one item with the VM ID, operation name, and success status.

Inputs

  • VM ID (vmId) (required) — The ID of the VM to force-stop.

Output shape

A single item containing id, operation (forceStop), and success fields.

If the API response does not include a success value, success is returned as false. GraphQL errors without response data are raised as node errors; with Continue On Fail enabled, the error is returned in an item.

Links

Discussion