v2

latestOpenAPI 3.0.1Apache 2.02026-07-2698173135.4 KB
Machines

Create Machine

Create a Machine within a specific app using the details provided in the request body.

Important: This request can fail, and you’re responsible for handling that failure. If you ask for a large Machine, or a Machine in a region we happen to be at capacity for, you might need to retry the request, or to fall back to another region. If you’re working directly with the Machines API, you’re taking some responsibility for your own orchestration!

post/apps/{app_name}/machines

Path parameters

app_namestring required

Fly App Name

Request body

lease_ttlinteger
min_secrets_versioninteger
namestring

Unique name for this Machine. If omitted, one is generated for you

regionstring

The target region. Omitting this param launches in the same region as your WireGuard peer connection (somewhere near you).

skip_launchboolean
skip_secretsboolean
skip_service_registrationboolean

Response

OK

cordonedboolean
created_atstring
host_status'ok' | 'unknown' | 'unreachable'
idstring
instance_idstring

InstanceID is unique for each version of the machine

namestring
noncestring

Nonce is only every returned on machine creation if a lease_duration was provided.

private_ipstring

PrivateIP is the internal 6PN address of the machine.

regionstring
statestring
updated_atstring