September 2025

Machines API – Create/update and delete machines

Date: 2025-09-29
Scope: VDI & DaaS Configuration API – Machines endpoints

Summary

  • Create or update machine (upsert) now explicitly documents partial-update behavior for existing machines.
  • New-machine upserts may trigger Monitor-driven agent deployment when the console setting is enabled.
  • Delete endpoint behavior and per-item statuses are clarified.

POST /v1/machines (Upsert)

  • Identity: Determined by FQDN computed from computerName or computerName.domainName.
  • Partial updates: When a machine already exists, only provided fields that differ from current values are applied; unspecified fields remain unchanged.
  • Automatic agent deployment (Monitor): If the ControlUp Console setting “Deploy agents automatically (from monitor only)” is enabled, adding a new machine via this endpoint will cause the ControlUp Monitor to attempt agent deployment to that machine automatically.
    • Runs from the Monitor service.
    • Requires Monitor domain credentials with local administrator rights on target machines.
    • Requires network reachability and prerequisites (e.g., firewall, RPC/WMI/SMB, framework requirements) as per standard agent deployment.
  • Examples: folderPath examples now use \\orgname\\foldername.

DELETE /v1/machines (Bulk Delete)

  • Behavior clarified (no contract change):
    • Deletes machines in bulk by FQDN.
    • Returns per-item status in affectedMachines using ItemDeletionStatus:
      • Deleted, NotFound, AlreadyWasDeleted, Unspecified.
    • Validation errors are returned for invalid payloads.

Breaking Changes

  • None.

Action Required

  • For inbound agents only: If you expect automatic agent deployment after upsert, ensure the Agent settings in the Console “Deploy agents automatically (from monitor only)” is enabled and that the Monitor has the required domain credentials and network access (Agent inbound port 40705)