v1
latestOpenAPI 3.0.02026-07-2321110.8 KBMachines
Update Machine
Update machine settings. All parameters are optional; only sent fields are updated.
Headers
| Name | Type |
|---|---|
| Authorization* | HMAC {key}:{signature}:{nonce}:{timestamp} |
| Content-Type | application/json |
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| id* | Integer | Machine ID |
Request Body
| Parameter | Type | Description |
|---|---|---|
| auto_stop_threshold | Integer | Auto-stop threshold in seconds. Options": "0", "900", "3600", "10800", "21600". "0" to disable. |
| usage_source | String | "team_balance" or "machine". Controls whether usage is drawn from team balance or machine-only balance. |
Success Response Fields
| Field | Type | Description |
|---|---|---|
| id | String | Machine ID |
| type | String | Always "machine" |
| attributes.name | String | Machine Name |
| attributes.os | String | Operating system: windows or linux |
| attributes.last_session_start_at | String | Last session start time (ISO 8601). null if no session |
| attributes.auto_stop_threshold | Integer | Auto-stop threshold in seconds |
| attributes.file_storage_size | Integer | Vagon Files storage size in GB |
| attributes.disk_size | Integer | Machine disk size in GB |
| attributes.network_credit | Integer | Available outbound network credits in bytes |
| attributes.assigned_image_id | Integer | Assigned image/template ID. null if none |
| attributes.assigned_image_name | String | Name of the assigned base image/template. null if none |
| attributes.region | String | Machine region |
| attributes.machine_type | String | Machine Performance Type |
| attributes.remaining_usage | Integer | Remaining usage time in minutes |
| attributes.deposited_usage | Integer | Deposited usage time in minutes |
| attributes.friendly_status | String | Machine Status |
| attributes.user | Object | Assigned User (null if no user) |
| attributes.user.id | String | User UUID |
| attributes.user.type | String | Always "user" |
| attributes.user.attributes.email | String | User email |
| attributes.user.attributes.name | String | User name |
| attributes.permissions | Object | Machine Permissions |
| attributes.usage_source | String | Usage source - "machine" (only assigned usages) or "team_balance" (can use team balance when no additional usage on machine) |
| attributes.task | Object | Active task on the machine (null if no task is active) |
| attributes.task.id | Integer | Active task ID on the machine |
| attributes.task.uid | String | Unique human-readable task name / uid for the machine |
| attributes.task.created_at | String | Task creation timestamp to the machine (ISO 8601) |
| attributes.latest_image_status | String | Snapshot state of the latest machine image. One of in_use, processing, ready, or null. null = machine has no user data yet (never started, or reset since); in_use = machine is not off; processing = a snapshot is being captured; ready = machine is off and no snapshot is being captured. |
| client_code | Integer | Response code (200 for success) |
| message | String | Response message |
| timestamp | String | Response timestamp (ISO 8601) |
patch/machines/{id}
Request body
Response
Machine updated successfully