Skip to main content
PATCH
Update machine execution defaults

Authorizations

Authorization
string
header
required

An opaque Omnara personal or organization bearer token.

Path Parameters

orgID
string
required
Pattern: ^org_[a-z2-7]{26}$
machineID
string
required
Pattern: ^mch_[a-z2-7]{26}$

Body

application/json
cwd
string
env
object
secret_env
object

Response

Machine updated.

id
string
required
Pattern: ^mch_[a-z2-7]{26}$
org_id
string
required
Pattern: ^org_[a-z2-7]{26}$
source_kind
enum<string>
required
Available options:
byo,
pool
display_name
string
required

Human-readable name. Spaces and punctuation are allowed; leading or trailing whitespace and invisible or control characters are not.

Required string length: 1 - 64
description
string
required
provider
string
required
lifecycle_state
enum<string>
required
Available options:
provisioning,
provision_failed,
active,
deleting,
delete_failed,
deleted
connection_state
enum<string>
required
Available options:
online,
asleep,
offline
last_observed_at
string<date-time> | null
required
cwd
string
required
env
object
required
secret_env
object
required
lifecycle_reason_code
string
required
lifecycle_reason_message
string
required
next_reconcile_after
string<date-time> | null
required
provision_attempts
integer<int32>
required
delete_attempts
integer<int32>
required
metadata
object
required

Arbitrary key-value metadata. Maximum 16 pairs, keys up to 64 characters, values must be strings of up to 512 characters.

deleted_at
string<date-time> | null
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
machine_pool_id
string | null
Pattern: ^mpo_[a-z2-7]{26}$
connection_state_reason
string
failure_report
object

The machine's most recent daemon-reported failure. A single slot, overwritten by newer reports and cleared when the daemon recovers.