v1

latestOpenAPI 3.0.1Apache 2.02026-07-1476137102.3 KB
Machines

Create Lease

Create a lease for a specific Machine within an app using the details provided in the request body. Machine leases can be used to obtain an exclusive lock on modifying a Machine.

post/apps/{app_name}/machines/{machine_id}/lease

Path parameters

app_namestring required

Fly App Name

machine_idstring required

Machine ID

Headers

fly-machine-lease-noncestring

Existing lease nonce to refresh by ttl, empty or non-existent to create a new lease

Request body

descriptionstring
ttlinteger

seconds lease will be valid

Response

Created

descriptionstring

Description or reason for the Lease.

expires_atinteger

ExpiresAt is the unix timestamp in UTC to denote when the Lease will no longer be valid.

noncestring

Nonce is the unique ID autogenerated and associated with the Lease.

ownerstring

Owner is the user identifier which acquired the Lease.

versionstring

Machine version