/fly | Type: Application | PCID required: Yes
Tools
fly_create_app
Create App Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
enable_subdomains | boolean | No | — | Enable Subdomains |
name | string | Yes | — | The name value |
network | string | No | — | The network value |
org_slug | string | Yes | — | Org Slug |
fly_create_deploy_token
Create App deploy token Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
app_name | string | Yes | — | Fly App Name |
expiry | string | No | — | The expiry value |
fly_create_ip_assignment
Assign new IP address to app Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
app_name | string | Yes | — | Fly App Name |
network | string | No | — | The network value |
org_slug | string | No | — | Org Slug |
region | string | No | — | The region value |
service_name | string | No | — | Service Name |
type | string | Yes | — | The type value |
fly_create_machine
Create Machine Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
app_name | string | Yes | — | Fly App Name |
config | object | Yes | — | An object defining the Machine configuration |
lease_ttl | integer | No | — | Lease Ttl |
min_secrets_version | integer | No | — | Min Secrets Version |
name | string | No | — | Unique name for this Machine. If omitted, one is generated for you |
region | string | No | — | The target region. Omitting this param launches in the same region as your WireGuard peer connection (somewhere near you). |
skip_launch | boolean | No | — | Skip Launch |
skip_secrets | boolean | No | — | Skip Secrets |
skip_service_registration | boolean | No | — | Skip Service Registration |
fly_create_secret
Create or update Secret Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
app_name | string | Yes | — | Fly App Name |
secret_name | string | Yes | — | App secret name |
value | string | Yes | — | The value value |
fly_create_volume
Create Volume Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
app_name | string | Yes | — | Fly App Name |
auto_backup_enabled | boolean | No | — | enable scheduled automatic snapshots. Defaults to true |
compute | object | No | — | The compute value |
compute_image | string | No | — | Compute Image |
encrypted | boolean | No | — | The encrypted value |
fstype | string | No | — | The fstype value |
name | string | Yes | — | The name value |
region | string | No | — | The region value |
require_unique_zone | boolean | No | — | Require Unique Zone |
size_gb | integer | Yes | — | Size Gb |
snapshot_id | string | No | — | restore from snapshot |
snapshot_retention | integer | No | — | Snapshot Retention |
source_volume_id | string | No | — | fork from remote volume |
unique_zone_app_wide | boolean | No | — | Unique Zone App Wide |
fly_create_volume_snapshot
Create Snapshot Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
app_name | string | Yes | — | Fly App Name |
volume_id | string | Yes | — | Volume ID |
fly_delete_app
Destroy App Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
app_name | string | Yes | — | Fly App Name |
fly_delete_ip_assignment
Remove IP assignment from app Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
app_name | string | Yes | — | Fly App Name |
ip | string | Yes | — | IP address |
fly_delete_machine
Destroy Machine Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
app_name | string | Yes | — | Fly App Name |
machine_id | string | Yes | — | Machine ID |
force | boolean | No | — | Force kill the machine if it’s running |
fly_delete_secret
Delete an app secret Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
app_name | string | Yes | — | Fly App Name |
secret_name | string | Yes | — | App secret name |
fly_delete_volume
Destroy Volume Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
app_name | string | Yes | — | Fly App Name |
volume_id | string | Yes | — | Volume ID |
fly_extend_volume
Extend Volume Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
app_name | string | Yes | — | Fly App Name |
volume_id | string | Yes | — | Volume ID |
size_gb | integer | Yes | — | Size Gb |
fly_get_app
Get App Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
app_name | string | Yes | — | Fly App Name |
fly_get_machine
Get Machine Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
app_name | string | Yes | — | Fly App Name |
machine_id | string | Yes | — | Machine ID |
fly_get_placements
Get Placements Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
compute | object | No | — | Resource requirements for the Machine to simulate. Defaults to a performance-1x machine |
count | integer | No | — | Number of machines to simulate placement. Defaults to 0, which returns the org-specific limit for each region. |
org_slug | string | Yes | — | Org Slug |
region | string | No | — | Region 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_name | string | No | — | Volume Name |
volume_size_bytes | integer | No | — | Volume Size Bytes |
weights | object | No | — | Optional weights to override default placement preferences. |
fly_get_volume
Get Volume Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
app_name | string | Yes | — | Fly App Name |
volume_id | string | Yes | — | Volume ID |
fly_list_apps
List Apps Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
org_slug | string | Yes | — | The org slug, or ‘personal’, to filter apps |
app_role | string | No | — | Filter apps by role |
fly_list_ip_assignments
List IP assignments for app Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
app_name | string | Yes | — | Fly App Name |
fly_list_machine_events
List Events Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
app_name | string | Yes | — | Fly App Name |
machine_id | string | Yes | — | Machine ID |
limit | integer | No | — | The number of events to fetch (max of 50). If omitted, this is set to 20 by default. |
fly_list_machine_processes
List Processes Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
app_name | string | Yes | — | Fly App Name |
machine_id | string | Yes | — | Machine ID |
sort_by | string | No | — | Sort by |
order | string | No | — | The order value |
fly_list_machines
List Machines Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
app_name | string | Yes | — | Fly App Name |
include_deleted | boolean | No | — | Include deleted machines |
region | string | No | — | Region filter |
state | string | No | — | comma separated list of states to filter (created, started, stopped, suspended) |
summary | boolean | No | — | Only return summary info about machines (omit config, checks, events, host_status, nonce, etc.) |
fly_list_org_machines
List All Machines Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
org_slug | string | Yes | — | Fly Organization Slug |
include_deleted | boolean | No | — | Include deleted machines |
region | string | No | — | Region filter |
state | string | No | — | Comma separated list of states to filter (created, started, stopped, suspended) |
summary | boolean | No | — | Omit config from responses |
updated_after | string | No | — | Only return machines updated after this time. Timestamp must be in the RFC 3339 format |
cursor | string | No | — | Pagination 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. |
limit | integer | No | — | The 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 Regionsfly_list_secrets
List app secrets belonging to an app Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
app_name | string | Yes | — | Fly App Name |
min_version | string | No | — | Minimum secrets version to return. Returned when setting a new secret |
show_secrets | boolean | No | — | Show the secret values. |
fly_list_volume_snapshots
List Snapshots Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
app_name | string | Yes | — | Fly App Name |
volume_id | string | Yes | — | Volume ID |
fly_list_volumes
List Volumes Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
app_name | string | Yes | — | Fly App Name |
summary | boolean | No | — | Only return summary info about volumes (omit blocks, block size, etc) |
fly_restart_machine
Restart Machine Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
app_name | string | Yes | — | Fly App Name |
machine_id | string | Yes | — | Machine ID |
timeout | string | No | — | Restart timeout as a Go duration string or number of seconds |
signal | string | No | — | Unix signal name |
fly_set_secrets
Update app secrets belonging to an app Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
app_name | string | Yes | — | Fly App Name |
values | object | No | — | The values value |
fly_signal_machine
Signal Machine Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
app_name | string | Yes | — | Fly App Name |
machine_id | string | Yes | — | Machine ID |
signal | string | Yes | — | The signal value |
fly_start_machine
Start Machine Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
app_name | string | Yes | — | Fly App Name |
machine_id | string | Yes | — | Machine ID |
fly_stop_machine
Stop Machine Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
app_name | string | Yes | — | Fly App Name |
machine_id | string | Yes | — | Machine ID |
signal | string | No | — | The signal value |
timeout | string | No | — | The timeout value |
fly_suspend_machine
Suspend Machine Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
app_name | string | Yes | — | Fly App Name |
machine_id | string | Yes | — | Machine ID |
fly_update_machine
Update Machine Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
app_name | string | Yes | — | Fly App Name |
machine_id | string | Yes | — | Machine ID |
config | object | No | — | An object defining the Machine configuration |
current_version | string | No | — | Current Version |
lease_ttl | integer | No | — | Lease Ttl |
min_secrets_version | integer | No | — | Min Secrets Version |
name | string | No | — | Unique name for this Machine. If omitted, one is generated for you |
region | string | No | — | The target region. Omitting this param launches in the same region as your WireGuard peer connection (somewhere near you). |
skip_launch | boolean | No | — | Skip Launch |
skip_secrets | boolean | No | — | Skip Secrets |
skip_service_registration | boolean | No | — | Skip Service Registration |
fly_update_volume
Update Volume Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
app_name | string | Yes | — | Fly App Name |
volume_id | string | Yes | — | Volume ID |
auto_backup_enabled | boolean | No | — | Auto Backup Enabled |
snapshot_retention | integer | No | — | Snapshot Retention |
fly_wait_for_machine_state
Wait for State Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
app_name | string | Yes | — | Fly App Name |
machine_id | string | Yes | — | Machine ID |
machine_version | string | No | — | 26-character Machine version ID |
instance_id | string | No | — | 26-character Machine version ID (deprecated; use version) |
from_event_id | string | No | — | 26-character Machine event ID to start waiting after |
timeout | integer | No | — | wait timeout. default 60s |
state | string | No | — | desired state(s), supports repeated or comma-separated values |

