v1

latestOpenAPI 3.0.1Apache 2.02026-07-1476137102.3 KB
Machines

Wait for State

Wait for a Machine to reach a specific state. Specify the desired state with the state parameter. See the Machine states table for a list of possible states. The default for this parameter is started.

This request will block for up to 60 seconds. Set a shorter timeout with the timeout parameter.

get/apps/{app_name}/machines/{machine_id}/wait

Path parameters

app_namestring required

Fly App Name

machine_idstring required

Machine ID

Query parameters

versionstring

26-character Machine version ID

instance_idstring

26-character Machine version ID (deprecated; use version)

from_event_idstring

26-character Machine event ID to start waiting after

timeoutinteger

wait timeout. default 60s

state'started' | 'stopped' | 'suspended' | 'destroyed' | 'failed' | 'settled'

desired state(s), supports repeated or comma-separated values

Response

OK

event_idstring
okboolean
statestring
versionstring