Skip to main content
Server path: /fly | Type: Application | PCID required: Yes

Tools

ToolDescription
fly_create_appCreate App
fly_create_deploy_tokenCreate App deploy token
fly_create_ip_assignmentAssign new IP address to app
fly_create_machineCreate Machine
fly_create_secretCreate or update Secret
fly_create_volumeCreate Volume
fly_create_volume_snapshotCreate Snapshot
fly_delete_appDestroy App
fly_delete_ip_assignmentRemove IP assignment from app
fly_delete_machineDestroy Machine
fly_delete_secretDelete an app secret
fly_delete_volumeDestroy Volume
fly_extend_volumeExtend Volume
fly_get_appGet App
fly_get_machineGet Machine
fly_get_placementsGet Placements
fly_get_volumeGet Volume
fly_list_appsList Apps
fly_list_ip_assignmentsList IP assignments for app
fly_list_machine_eventsList Events
fly_list_machine_processesList Processes
fly_list_machinesList Machines
fly_list_org_machinesList All Machines
fly_list_regionsGet Regions
fly_list_secretsList app secrets belonging to an app
fly_list_volume_snapshotsList Snapshots
fly_list_volumesList Volumes
fly_restart_machineRestart Machine
fly_set_secretsUpdate app secrets belonging to an app
fly_signal_machineSignal Machine
fly_start_machineStart Machine
fly_stop_machineStop Machine
fly_suspend_machineSuspend Machine
fly_update_machineUpdate Machine
fly_update_volumeUpdate Volume
fly_wait_for_machine_stateWait for State

fly_create_app

Create App Parameters:
ParameterTypeRequiredDefaultDescription
enable_subdomainsbooleanNoEnable Subdomains
namestringYesThe name value
networkstringNoThe network value
org_slugstringYesOrg Slug

fly_create_deploy_token

Create App deploy token Parameters:
ParameterTypeRequiredDefaultDescription
app_namestringYesFly App Name
expirystringNoThe expiry value

fly_create_ip_assignment

Assign new IP address to app Parameters:
ParameterTypeRequiredDefaultDescription
app_namestringYesFly App Name
networkstringNoThe network value
org_slugstringNoOrg Slug
regionstringNoThe region value
service_namestringNoService Name
typestringYesThe type value

fly_create_machine

Create Machine Parameters:
ParameterTypeRequiredDefaultDescription
app_namestringYesFly App Name
configobjectYesAn object defining the Machine configuration
lease_ttlintegerNoLease Ttl
min_secrets_versionintegerNoMin Secrets Version
namestringNoUnique name for this Machine. If omitted, one is generated for you
regionstringNoThe target region. Omitting this param launches in the same region as your WireGuard peer connection (somewhere near you).
skip_launchbooleanNoSkip Launch
skip_secretsbooleanNoSkip Secrets
skip_service_registrationbooleanNoSkip Service Registration

fly_create_secret

Create or update Secret Parameters:
ParameterTypeRequiredDefaultDescription
app_namestringYesFly App Name
secret_namestringYesApp secret name
valuestringYesThe value value

fly_create_volume

Create Volume Parameters:
ParameterTypeRequiredDefaultDescription
app_namestringYesFly App Name
auto_backup_enabledbooleanNoenable scheduled automatic snapshots. Defaults to true
computeobjectNoThe compute value
compute_imagestringNoCompute Image
encryptedbooleanNoThe encrypted value
fstypestringNoThe fstype value
namestringYesThe name value
regionstringNoThe region value
require_unique_zonebooleanNoRequire Unique Zone
size_gbintegerYesSize Gb
snapshot_idstringNorestore from snapshot
snapshot_retentionintegerNoSnapshot Retention
source_volume_idstringNofork from remote volume
unique_zone_app_widebooleanNoUnique Zone App Wide

fly_create_volume_snapshot

Create Snapshot Parameters:
ParameterTypeRequiredDefaultDescription
app_namestringYesFly App Name
volume_idstringYesVolume ID

fly_delete_app

Destroy App Parameters:
ParameterTypeRequiredDefaultDescription
app_namestringYesFly App Name

fly_delete_ip_assignment

Remove IP assignment from app Parameters:
ParameterTypeRequiredDefaultDescription
app_namestringYesFly App Name
ipstringYesIP address

fly_delete_machine

Destroy Machine Parameters:
ParameterTypeRequiredDefaultDescription
app_namestringYesFly App Name
machine_idstringYesMachine ID
forcebooleanNoForce kill the machine if it’s running

fly_delete_secret

Delete an app secret Parameters:
ParameterTypeRequiredDefaultDescription
app_namestringYesFly App Name
secret_namestringYesApp secret name

fly_delete_volume

Destroy Volume Parameters:
ParameterTypeRequiredDefaultDescription
app_namestringYesFly App Name
volume_idstringYesVolume ID

fly_extend_volume

Extend Volume Parameters:
ParameterTypeRequiredDefaultDescription
app_namestringYesFly App Name
volume_idstringYesVolume ID
size_gbintegerYesSize Gb

fly_get_app

Get App Parameters:
ParameterTypeRequiredDefaultDescription
app_namestringYesFly App Name

fly_get_machine

Get Machine Parameters:
ParameterTypeRequiredDefaultDescription
app_namestringYesFly App Name
machine_idstringYesMachine ID

fly_get_placements

Get Placements Parameters:
ParameterTypeRequiredDefaultDescription
computeobjectNoResource requirements for the Machine to simulate. Defaults to a performance-1x machine
countintegerNoNumber of machines to simulate placement. Defaults to 0, which returns the org-specific limit for each region.
org_slugstringYesOrg Slug
regionstringNoRegion expression for placement as a comma-delimited set of regions or aliases. Defaults to “[region],any”, to prefer the API endpoint’s local region with any other region as fallback.
volume_namestringNoVolume Name
volume_size_bytesintegerNoVolume Size Bytes
weightsobjectNoOptional weights to override default placement preferences.

fly_get_volume

Get Volume Parameters:
ParameterTypeRequiredDefaultDescription
app_namestringYesFly App Name
volume_idstringYesVolume ID

fly_list_apps

List Apps Parameters:
ParameterTypeRequiredDefaultDescription
org_slugstringYesThe org slug, or ‘personal’, to filter apps
app_rolestringNoFilter apps by role

fly_list_ip_assignments

List IP assignments for app Parameters:
ParameterTypeRequiredDefaultDescription
app_namestringYesFly App Name

fly_list_machine_events

List Events Parameters:
ParameterTypeRequiredDefaultDescription
app_namestringYesFly App Name
machine_idstringYesMachine ID
limitintegerNoThe number of events to fetch (max of 50). If omitted, this is set to 20 by default.

fly_list_machine_processes

List Processes Parameters:
ParameterTypeRequiredDefaultDescription
app_namestringYesFly App Name
machine_idstringYesMachine ID
sort_bystringNoSort by
orderstringNoThe order value

fly_list_machines

List Machines Parameters:
ParameterTypeRequiredDefaultDescription
app_namestringYesFly App Name
include_deletedbooleanNoInclude deleted machines
regionstringNoRegion filter
statestringNocomma separated list of states to filter (created, started, stopped, suspended)
summarybooleanNoOnly return summary info about machines (omit config, checks, events, host_status, nonce, etc.)

fly_list_org_machines

List All Machines Parameters:
ParameterTypeRequiredDefaultDescription
org_slugstringYesFly Organization Slug
include_deletedbooleanNoInclude deleted machines
regionstringNoRegion filter
statestringNoComma separated list of states to filter (created, started, stopped, suspended)
summarybooleanNoOmit config from responses
updated_afterstringNoOnly return machines updated after this time. Timestamp must be in the RFC 3339 format
cursorstringNoPagination cursor from previous response (takes precedence over updated_after). Note that there is no guarantee that all machines returned by this endpoint are sorted by their updated_at fields. Pagination may reveal machines older than the last updated_at.
limitintegerNoThe number of machines to fetch (max of 1000). This limit is advisory. Responses may be shorter, or even empty, even when more machines remain. If omitted, the maximum is used

fly_list_regions

Get Regions

fly_list_secrets

List app secrets belonging to an app Parameters:
ParameterTypeRequiredDefaultDescription
app_namestringYesFly App Name
min_versionstringNoMinimum secrets version to return. Returned when setting a new secret
show_secretsbooleanNoShow the secret values.

fly_list_volume_snapshots

List Snapshots Parameters:
ParameterTypeRequiredDefaultDescription
app_namestringYesFly App Name
volume_idstringYesVolume ID

fly_list_volumes

List Volumes Parameters:
ParameterTypeRequiredDefaultDescription
app_namestringYesFly App Name
summarybooleanNoOnly return summary info about volumes (omit blocks, block size, etc)

fly_restart_machine

Restart Machine Parameters:
ParameterTypeRequiredDefaultDescription
app_namestringYesFly App Name
machine_idstringYesMachine ID
timeoutstringNoRestart timeout as a Go duration string or number of seconds
signalstringNoUnix signal name

fly_set_secrets

Update app secrets belonging to an app Parameters:
ParameterTypeRequiredDefaultDescription
app_namestringYesFly App Name
valuesobjectNoThe values value

fly_signal_machine

Signal Machine Parameters:
ParameterTypeRequiredDefaultDescription
app_namestringYesFly App Name
machine_idstringYesMachine ID
signalstringYesThe signal value

fly_start_machine

Start Machine Parameters:
ParameterTypeRequiredDefaultDescription
app_namestringYesFly App Name
machine_idstringYesMachine ID

fly_stop_machine

Stop Machine Parameters:
ParameterTypeRequiredDefaultDescription
app_namestringYesFly App Name
machine_idstringYesMachine ID
signalstringNoThe signal value
timeoutstringNoThe timeout value

fly_suspend_machine

Suspend Machine Parameters:
ParameterTypeRequiredDefaultDescription
app_namestringYesFly App Name
machine_idstringYesMachine ID

fly_update_machine

Update Machine Parameters:
ParameterTypeRequiredDefaultDescription
app_namestringYesFly App Name
machine_idstringYesMachine ID
configobjectNoAn object defining the Machine configuration
current_versionstringNoCurrent Version
lease_ttlintegerNoLease Ttl
min_secrets_versionintegerNoMin Secrets Version
namestringNoUnique name for this Machine. If omitted, one is generated for you
regionstringNoThe target region. Omitting this param launches in the same region as your WireGuard peer connection (somewhere near you).
skip_launchbooleanNoSkip Launch
skip_secretsbooleanNoSkip Secrets
skip_service_registrationbooleanNoSkip Service Registration

fly_update_volume

Update Volume Parameters:
ParameterTypeRequiredDefaultDescription
app_namestringYesFly App Name
volume_idstringYesVolume ID
auto_backup_enabledbooleanNoAuto Backup Enabled
snapshot_retentionintegerNoSnapshot Retention

fly_wait_for_machine_state

Wait for State Parameters:
ParameterTypeRequiredDefaultDescription
app_namestringYesFly App Name
machine_idstringYesMachine ID
machine_versionstringNo26-character Machine version ID
instance_idstringNo26-character Machine version ID (deprecated; use version)
from_event_idstringNo26-character Machine event ID to start waiting after
timeoutintegerNowait timeout. default 60s
statestringNodesired state(s), supports repeated or comma-separated values