> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt
> Use this file to discover all available pages before exploring further.
# fly
> Fly.io Platform
**Server path:** `/fly` | **Type:** Application | **PCID required:** Yes
## Tools
| Tool | Description |
| ----------------------------------------------------------- | -------------------------------------- |
| [`fly_create_app`](#fly_create_app) | Create App |
| [`fly_create_deploy_token`](#fly_create_deploy_token) | Create App deploy token |
| [`fly_create_ip_assignment`](#fly_create_ip_assignment) | Assign new IP address to app |
| [`fly_create_machine`](#fly_create_machine) | Create Machine |
| [`fly_create_secret`](#fly_create_secret) | Create or update Secret |
| [`fly_create_volume`](#fly_create_volume) | Create Volume |
| [`fly_create_volume_snapshot`](#fly_create_volume_snapshot) | Create Snapshot |
| [`fly_delete_app`](#fly_delete_app) | Destroy App |
| [`fly_delete_ip_assignment`](#fly_delete_ip_assignment) | Remove IP assignment from app |
| [`fly_delete_machine`](#fly_delete_machine) | Destroy Machine |
| [`fly_delete_secret`](#fly_delete_secret) | Delete an app secret |
| [`fly_delete_volume`](#fly_delete_volume) | Destroy Volume |
| [`fly_extend_volume`](#fly_extend_volume) | Extend Volume |
| [`fly_get_app`](#fly_get_app) | Get App |
| [`fly_get_machine`](#fly_get_machine) | Get Machine |
| [`fly_get_placements`](#fly_get_placements) | Get Placements |
| [`fly_get_volume`](#fly_get_volume) | Get Volume |
| [`fly_list_apps`](#fly_list_apps) | List Apps |
| [`fly_list_ip_assignments`](#fly_list_ip_assignments) | List IP assignments for app |
| [`fly_list_machine_events`](#fly_list_machine_events) | List Events |
| [`fly_list_machine_processes`](#fly_list_machine_processes) | List Processes |
| [`fly_list_machines`](#fly_list_machines) | List Machines |
| [`fly_list_org_machines`](#fly_list_org_machines) | List All Machines |
| [`fly_list_regions`](#fly_list_regions) | Get Regions |
| [`fly_list_secrets`](#fly_list_secrets) | List app secrets belonging to an app |
| [`fly_list_volume_snapshots`](#fly_list_volume_snapshots) | List Snapshots |
| [`fly_list_volumes`](#fly_list_volumes) | List Volumes |
| [`fly_restart_machine`](#fly_restart_machine) | Restart Machine |
| [`fly_set_secrets`](#fly_set_secrets) | Update app secrets belonging to an app |
| [`fly_signal_machine`](#fly_signal_machine) | Signal Machine |
| [`fly_start_machine`](#fly_start_machine) | Start Machine |
| [`fly_stop_machine`](#fly_stop_machine) | Stop Machine |
| [`fly_suspend_machine`](#fly_suspend_machine) | Suspend Machine |
| [`fly_update_machine`](#fly_update_machine) | Update Machine |
| [`fly_update_volume`](#fly_update_volume) | Update Volume |
| [`fly_wait_for_machine_state`](#fly_wait_for_machine_state) | Wait for State |
***
## 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 |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"enable_subdomains": {
"type": "boolean",
"description": "Enable Subdomains"
},
"name": {
"type": "string",
"description": "The name value"
},
"network": {
"type": "string",
"description": "The network value"
},
"org_slug": {
"type": "string",
"description": "Org Slug"
}
},
"required": [
"PCID",
"name",
"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 |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"app_name": {
"type": "string",
"description": "Fly App Name"
},
"expiry": {
"type": "string",
"description": "The expiry value"
}
},
"required": [
"PCID",
"app_name"
]
}
```
***
## 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 |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"app_name": {
"type": "string",
"description": "Fly App Name"
},
"network": {
"type": "string",
"description": "The network value"
},
"org_slug": {
"type": "string",
"description": "Org Slug"
},
"region": {
"type": "string",
"description": "The region value"
},
"service_name": {
"type": "string",
"description": "Service Name"
},
"type": {
"type": "string",
"description": "The type value"
}
},
"required": [
"PCID",
"app_name",
"type"
]
}
```
***
## 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 |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"app_name": {
"type": "string",
"description": "Fly App Name"
},
"config": {
"type": "object",
"description": "An object defining the Machine configuration"
},
"lease_ttl": {
"type": "integer",
"description": "Lease Ttl"
},
"min_secrets_version": {
"type": "integer",
"description": "Min Secrets Version"
},
"name": {
"type": "string",
"description": "Unique name for this Machine. If omitted, one is generated for you"
},
"region": {
"type": "string",
"description": "The target region. Omitting this param launches in the same region as your WireGuard peer connection (somewhere near you)."
},
"skip_launch": {
"type": "boolean",
"description": "Skip Launch"
},
"skip_secrets": {
"type": "boolean",
"description": "Skip Secrets"
},
"skip_service_registration": {
"type": "boolean",
"description": "Skip Service Registration"
}
},
"required": [
"PCID",
"app_name",
"config"
]
}
```
***
## 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 |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"app_name": {
"type": "string",
"description": "Fly App Name"
},
"secret_name": {
"type": "string",
"description": "App secret name"
},
"value": {
"type": "string",
"description": "The value value"
}
},
"required": [
"PCID",
"app_name",
"secret_name",
"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 |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"app_name": {
"type": "string",
"description": "Fly App Name"
},
"auto_backup_enabled": {
"type": "boolean",
"description": "enable scheduled automatic snapshots. Defaults to `true`"
},
"compute": {
"type": "object",
"description": "The compute value",
"properties": {
"cpu_kind": {
"type": "string",
"description": "Cpu Kind"
},
"cpus": {
"type": "integer",
"description": "The cpus value"
},
"gpu_kind": {
"type": "string",
"description": "Gpu Kind"
},
"gpus": {
"type": "integer",
"description": "The gpus value"
},
"host_dedication_id": {
"type": "string",
"description": "Host Dedication Id"
},
"kernel_args": {
"type": "array",
"items": {
"type": "string"
},
"description": "Kernel Args"
},
"max_memory_mb": {
"type": "integer",
"description": "Max Memory Mb"
},
"memory_mb": {
"type": "integer",
"description": "Memory Mb"
},
"persist_rootfs": {
"type": "string",
"description": "Deprecated: use MachineConfig.Rootfs instead",
"enum": [
"never",
"always",
"restart"
]
}
}
},
"compute_image": {
"type": "string",
"description": "Compute Image"
},
"encrypted": {
"type": "boolean",
"description": "The encrypted value"
},
"fstype": {
"type": "string",
"description": "The fstype value"
},
"name": {
"type": "string",
"description": "The name value"
},
"region": {
"type": "string",
"description": "The region value"
},
"require_unique_zone": {
"type": "boolean",
"description": "Require Unique Zone"
},
"size_gb": {
"type": "integer",
"description": "Size Gb"
},
"snapshot_id": {
"type": "string",
"description": "restore from snapshot"
},
"snapshot_retention": {
"type": "integer",
"description": "Snapshot Retention"
},
"source_volume_id": {
"type": "string",
"description": "fork from remote volume"
},
"unique_zone_app_wide": {
"type": "boolean",
"description": "Unique Zone App Wide"
}
},
"required": [
"PCID",
"app_name",
"name",
"size_gb"
]
}
```
***
## 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 |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"app_name": {
"type": "string",
"description": "Fly App Name"
},
"volume_id": {
"type": "string",
"description": "Volume ID"
}
},
"required": [
"PCID",
"app_name",
"volume_id"
]
}
```
***
## fly\_delete\_app
Destroy App
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------- | ------ | -------- | ------- | ------------ |
| `app_name` | string | Yes | — | Fly App Name |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"app_name": {
"type": "string",
"description": "Fly App Name"
}
},
"required": [
"PCID",
"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 |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"app_name": {
"type": "string",
"description": "Fly App Name"
},
"ip": {
"type": "string",
"description": "IP address"
}
},
"required": [
"PCID",
"app_name",
"ip"
]
}
```
***
## 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 |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"app_name": {
"type": "string",
"description": "Fly App Name"
},
"machine_id": {
"type": "string",
"description": "Machine ID"
},
"force": {
"type": "boolean",
"description": "Force kill the machine if it's running"
}
},
"required": [
"PCID",
"app_name",
"machine_id"
]
}
```
***
## 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 |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"app_name": {
"type": "string",
"description": "Fly App Name"
},
"secret_name": {
"type": "string",
"description": "App secret name"
}
},
"required": [
"PCID",
"app_name",
"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 |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"app_name": {
"type": "string",
"description": "Fly App Name"
},
"volume_id": {
"type": "string",
"description": "Volume ID"
}
},
"required": [
"PCID",
"app_name",
"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 |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"app_name": {
"type": "string",
"description": "Fly App Name"
},
"volume_id": {
"type": "string",
"description": "Volume ID"
},
"size_gb": {
"type": "integer",
"description": "Size Gb"
}
},
"required": [
"PCID",
"app_name",
"volume_id",
"size_gb"
]
}
```
***
## fly\_get\_app
Get App
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------- | ------ | -------- | ------- | ------------ |
| `app_name` | string | Yes | — | Fly App Name |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"app_name": {
"type": "string",
"description": "Fly App Name"
}
},
"required": [
"PCID",
"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 |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"app_name": {
"type": "string",
"description": "Fly App Name"
},
"machine_id": {
"type": "string",
"description": "Machine ID"
}
},
"required": [
"PCID",
"app_name",
"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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"compute": {
"type": "object",
"description": "Resource requirements for the Machine to simulate. Defaults to a performance-1x machine"
},
"count": {
"type": "integer",
"description": "Number of machines to simulate placement. Defaults to 0, which returns the org-specific limit for each region."
},
"org_slug": {
"type": "string",
"description": "Org Slug"
},
"region": {
"type": "string",
"description": "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": {
"type": "string",
"description": "Volume Name"
},
"volume_size_bytes": {
"type": "integer",
"description": "Volume Size Bytes"
},
"weights": {
"type": "object",
"description": "Optional weights to override default placement preferences."
}
},
"required": [
"PCID",
"org_slug"
]
}
```
***
## fly\_get\_volume
Get Volume
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------- | ------ | -------- | ------- | ------------ |
| `app_name` | string | Yes | — | Fly App Name |
| `volume_id` | string | Yes | — | Volume ID |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"app_name": {
"type": "string",
"description": "Fly App Name"
},
"volume_id": {
"type": "string",
"description": "Volume ID"
}
},
"required": [
"PCID",
"app_name",
"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 |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"org_slug": {
"type": "string",
"description": "The org slug, or 'personal', to filter apps"
},
"app_role": {
"type": "string",
"description": "Filter apps by role"
}
},
"required": [
"PCID",
"org_slug"
]
}
```
***
## fly\_list\_ip\_assignments
List IP assignments for app
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------- | ------ | -------- | ------- | ------------ |
| `app_name` | string | Yes | — | Fly App Name |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"app_name": {
"type": "string",
"description": "Fly App Name"
}
},
"required": [
"PCID",
"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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"app_name": {
"type": "string",
"description": "Fly App Name"
},
"machine_id": {
"type": "string",
"description": "Machine ID"
},
"limit": {
"type": "integer",
"description": "The number of events to fetch (max of 50). If omitted, this is set to 20 by default."
}
},
"required": [
"PCID",
"app_name",
"machine_id"
]
}
```
***
## 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 |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"app_name": {
"type": "string",
"description": "Fly App Name"
},
"machine_id": {
"type": "string",
"description": "Machine ID"
},
"sort_by": {
"type": "string",
"description": "Sort by"
},
"order": {
"type": "string",
"description": "The order value"
}
},
"required": [
"PCID",
"app_name",
"machine_id"
]
}
```
***
## 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.) |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"app_name": {
"type": "string",
"description": "Fly App Name"
},
"include_deleted": {
"type": "boolean",
"description": "Include deleted machines"
},
"region": {
"type": "string",
"description": "Region filter"
},
"state": {
"type": "string",
"description": "comma separated list of states to filter (created, started, stopped, suspended)"
},
"summary": {
"type": "boolean",
"description": "Only return summary info about machines (omit config, checks, events, host_status, nonce, etc.)"
}
},
"required": [
"PCID",
"app_name"
]
}
```
***
## 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 |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"org_slug": {
"type": "string",
"description": "Fly Organization Slug"
},
"include_deleted": {
"type": "boolean",
"description": "Include deleted machines"
},
"region": {
"type": "string",
"description": "Region filter"
},
"state": {
"type": "string",
"description": "Comma separated list of states to filter (created, started, stopped, suspended)"
},
"summary": {
"type": "boolean",
"description": "Omit config from responses"
},
"updated_after": {
"type": "string",
"description": "Only return machines updated after this time. Timestamp must be in the RFC 3339 format"
},
"cursor": {
"type": "string",
"description": "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": {
"type": "integer",
"description": "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"
}
},
"required": [
"PCID",
"org_slug"
]
}
```
***
## fly\_list\_regions
Get Regions
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
```
***
## fly\_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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"app_name": {
"type": "string",
"description": "Fly App Name"
},
"min_version": {
"type": "string",
"description": "Minimum secrets version to return. Returned when setting a new secret"
},
"show_secrets": {
"type": "boolean",
"description": "Show the secret values."
}
},
"required": [
"PCID",
"app_name"
]
}
```
***
## 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 |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"app_name": {
"type": "string",
"description": "Fly App Name"
},
"volume_id": {
"type": "string",
"description": "Volume ID"
}
},
"required": [
"PCID",
"app_name",
"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) |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"app_name": {
"type": "string",
"description": "Fly App Name"
},
"summary": {
"type": "boolean",
"description": "Only return summary info about volumes (omit blocks, block size, etc)"
}
},
"required": [
"PCID",
"app_name"
]
}
```
***
## 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 |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"app_name": {
"type": "string",
"description": "Fly App Name"
},
"machine_id": {
"type": "string",
"description": "Machine ID"
},
"timeout": {
"type": "string",
"description": "Restart timeout as a Go duration string or number of seconds"
},
"signal": {
"type": "string",
"description": "Unix signal name",
"enum": [
"SIGHUP",
"SIGINT",
"SIGQUIT",
"SIGKILL",
"SIGUSR1",
"SIGUSR2",
"SIGTERM"
]
}
},
"required": [
"PCID",
"app_name",
"machine_id"
]
}
```
***
## 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 |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"app_name": {
"type": "string",
"description": "Fly App Name"
},
"values": {
"type": "object",
"description": "The values value"
}
},
"required": [
"PCID",
"app_name"
]
}
```
***
## 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 |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"app_name": {
"type": "string",
"description": "Fly App Name"
},
"machine_id": {
"type": "string",
"description": "Machine ID"
},
"signal": {
"type": "string",
"description": "The signal value",
"enum": [
"SIGABRT",
"SIGALRM",
"SIGFPE",
"SIGHUP",
"SIGILL",
"SIGINT",
"SIGKILL",
"SIGPIPE",
"SIGQUIT",
"SIGSEGV",
"SIGTERM",
"SIGTRAP",
"SIGUSR1",
"SIGUSR2"
]
}
},
"required": [
"PCID",
"app_name",
"machine_id",
"signal"
]
}
```
***
## fly\_start\_machine
Start Machine
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------ | -------- | ------- | ------------ |
| `app_name` | string | Yes | — | Fly App Name |
| `machine_id` | string | Yes | — | Machine ID |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"app_name": {
"type": "string",
"description": "Fly App Name"
},
"machine_id": {
"type": "string",
"description": "Machine ID"
}
},
"required": [
"PCID",
"app_name",
"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 |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"app_name": {
"type": "string",
"description": "Fly App Name"
},
"machine_id": {
"type": "string",
"description": "Machine ID"
},
"signal": {
"type": "string",
"description": "The signal value",
"enum": [
"SIGHUP",
"SIGINT",
"SIGQUIT",
"SIGKILL",
"SIGUSR1",
"SIGUSR2",
"SIGTERM"
]
},
"timeout": {
"type": "string",
"description": "The timeout value"
}
},
"required": [
"PCID",
"app_name",
"machine_id"
]
}
```
***
## fly\_suspend\_machine
Suspend Machine
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------ | -------- | ------- | ------------ |
| `app_name` | string | Yes | — | Fly App Name |
| `machine_id` | string | Yes | — | Machine ID |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"app_name": {
"type": "string",
"description": "Fly App Name"
},
"machine_id": {
"type": "string",
"description": "Machine ID"
}
},
"required": [
"PCID",
"app_name",
"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 |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"app_name": {
"type": "string",
"description": "Fly App Name"
},
"machine_id": {
"type": "string",
"description": "Machine ID"
},
"config": {
"type": "object",
"description": "An object defining the Machine configuration"
},
"current_version": {
"type": "string",
"description": "Current Version"
},
"lease_ttl": {
"type": "integer",
"description": "Lease Ttl"
},
"min_secrets_version": {
"type": "integer",
"description": "Min Secrets Version"
},
"name": {
"type": "string",
"description": "Unique name for this Machine. If omitted, one is generated for you"
},
"region": {
"type": "string",
"description": "The target region. Omitting this param launches in the same region as your WireGuard peer connection (somewhere near you)."
},
"skip_launch": {
"type": "boolean",
"description": "Skip Launch"
},
"skip_secrets": {
"type": "boolean",
"description": "Skip Secrets"
},
"skip_service_registration": {
"type": "boolean",
"description": "Skip Service Registration"
}
},
"required": [
"PCID",
"app_name",
"machine_id"
]
}
```
***
## 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 |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"app_name": {
"type": "string",
"description": "Fly App Name"
},
"volume_id": {
"type": "string",
"description": "Volume ID"
},
"auto_backup_enabled": {
"type": "boolean",
"description": "Auto Backup Enabled"
},
"snapshot_retention": {
"type": "integer",
"description": "Snapshot Retention"
}
},
"required": [
"PCID",
"app_name",
"volume_id"
]
}
```
***
## 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 |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"app_name": {
"type": "string",
"description": "Fly App Name"
},
"machine_id": {
"type": "string",
"description": "Machine ID"
},
"machine_version": {
"type": "string",
"description": "26-character Machine version ID"
},
"instance_id": {
"type": "string",
"description": "26-character Machine version ID (deprecated; use version)"
},
"from_event_id": {
"type": "string",
"description": "26-character Machine event ID to start waiting after"
},
"timeout": {
"type": "integer",
"description": "wait timeout. default 60s"
},
"state": {
"type": "string",
"description": "desired state(s), supports repeated or comma-separated values",
"enum": [
"started",
"stopped",
"suspended",
"destroyed",
"failed",
"settled"
]
}
},
"required": [
"PCID",
"app_name",
"machine_id"
]
}
```