v1

latestOpenAPI 3.1.02026-07-22136108233.0 KB

machines

Create Machine

Create a new machine.

The machine will be associated with the authenticated organization.

post/v1/machines

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

machine_parametersobject nullable

Machine-specific input values that auto-populate runs

machine_sensitive_parametersobject nullable

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

fingerprintstring required

unkey_key_idstring required

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