Sign in

v1

latestOpenAPI 3.1.02026-07-22136108233.0 KB
machines

Update Machine

Update a machine's information.

Only the fields provided in the request body will be updated. The machine must belong to the authenticated organization.

For machine_sensitive_parameters: provide actual secret values and they will be stored in Basis Theory. Only aliases will be stored in the database.

patch/v1/machines/{machine_id}

Path parameters

machine_idstring uuid required

Headers

Idempotency-Keystring
Example:550e8400-e29b-41d4-a716-446655440000

Unique key for idempotent requests. If provided, the server ensures the request is processed at most once. Retries with the same key return the original response. SDKs auto-generate this for write requests.

Request body

namestring nullable
versionstring nullable
hostnamestring nullable
os_infostring nullable
status'connected' | 'disconnected' | 'error'
is_availableboolean nullable
alerts_enabledboolean nullable
last_seenstring date-time nullable
reserved_session_idstring uuid nullable

Set to null to clear reservation; server will cancel any scheduling/running run on this machine, clear reservation, mark machine available, and trigger matching

machine_parametersobject nullable

Machine-specific input values. Provide empty dict {} to clear all.

machine_sensitive_parametersobject nullable

Machine-specific sensitive input values (will be stored in Basis Theory). Provide empty dict {} to clear all.

Response

Successful Response

namestring nullable
versionstring nullable
hostnamestring nullable
os_infostring nullable
machine_parametersobject nullable

Machine-specific input values that auto-populate runs

machine_sensitive_parametersobject nullable

Machine-specific sensitive input aliases (stored in Basis Theory)

idstring uuid required
user_idstring uuid nullable
organization_idstring nullable
unkey_key_idstring required
status'connected' | 'disconnected' | 'error' required
is_availableboolean required
alerts_enabledboolean required
reserved_session_idstring uuid nullable
linked_keepalive_machine_idstring uuid nullable
physical_server_idstring nullable

Fly machine ID hosting the WebSocket connection

created_atstring date-time required
last_seenstring date-time required