> For the complete documentation index, see [llms.txt](https://docs.stackai.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.stackai.com/integrations/catalog/fly.io.md).

# Fly.io

Create and inspect Fly Apps and Machines, and manage machine lifecycle from Stack AI workflows.

### Connectors

Choose the connector that matches your authentication method. The options below use the names shown in StackAI.

| Connector | Authentication |
| --------- | -------------- |
| Fly.io    | API token      |

#### Fly.io

Connect to Fly.io with an organization token to list, inspect and create Apps and Machines, and start or stop Machines.

**Set up in Fly.io**

1. Sign in to Fly.io and select the organization whose apps you will manage. Confirm its trial or billing eligibility before creating resources.
2. Create an expiring organization token with write access for creation and lifecycle actions. A read-only organization token supports inspection only; an app deploy token does not support organization-wide discovery.

**Set up in StackAI**

1. Open **Settings → Connections**, add a connection, and select **Fly.io**.
2. Enter the credentials and connection details in the fields below.
3. Save the connection and check its connection status. Select this saved connection when configuring an action or feature that uses it.

**Connection fields**

| StackAI field     | Required | What to enter                                                                                                                                                                                                                   |
| ----------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| API token         | Yes      | A Fly.io organization token. Use a write-capable token to create, start or stop resources, or a read-only token when you only need to inspect Apps and Machines. [Provider instructions](https://fly.io/docs/security/tokens/). |
| Organization slug | Yes      | The exact slug of the Fly.io organization this token belongs to. It is used to verify the connection and load App dropdowns. [Provider instructions](https://fly.io/docs/flyctl/orgs/).                                         |

**Provider documentation:** [Setup reference](https://docs.fly.io/security/tokens/).

#### Verify the connection

Check that the connection is healthy. Then run a read operation against a resource the connected account can access. A successful connection check confirms authentication; it does not guarantee permission for every action.

If access is denied, check the credential or OAuth permissions, the selected account or environment, and access to the specific resource. Update expired credentials or reconnect after permissions change.

### Use an action

1. Add the required **Fly.io** action to the workflow.
2. Select a connection when the action requests one.
3. Complete the required fields. Use the reference picker when a value comes from another workflow step.
4. Run the workflow and inspect the action’s output. Check the result before using it in a later step.

### Actions

#### List Apps

List the Fly Apps in an organization.

**Inputs**

| Field               | Type    | Required | Description                                                                                            |
| ------------------- | ------- | -------- | ------------------------------------------------------------------------------------------------------ |
| Organization slug   | string  | No       | Organization to list. Uses the connection organization when omitted.                                   |
| Result limit        | integer | No       | Target number of results, from 1 to 1000. The complete final page may exceed this count. Default: 100. |
| Continuation cursor | string  | No       | Continue from the previous result using the same filters.                                              |

**Outputs**

| Field       | Type          | Description                                                              |
| ----------- | ------------- | ------------------------------------------------------------------------ |
| Apps        | object\_array | The Fly Apps in the organization.                                        |
| App count   | integer       | The number of Apps returned.                                             |
| Next cursor | string        | Use this cursor to fetch more results. Empty means the list is complete. |

#### Get App

Get the status and resource counts for one Fly App.

**Inputs**

| Field             | Type            | Required | Description                                                               |
| ----------------- | --------------- | -------- | ------------------------------------------------------------------------- |
| Organization slug | string          | No       | Organization for the App picker. Defaults to the connection organization. |
| App               | select (string) | Yes      | The Fly App to inspect. Options load from the selected connection.        |

**Outputs**

| Field    | Type   | Description                                            |
| -------- | ------ | ------------------------------------------------------ |
| App      | object | The Fly App and its organization and resource details. |
| App name | string | The App's unique Fly.io name.                          |
| Status   | string | The App's current status.                              |

#### List Machines

List Machines in a Fly App with optional state and region filters.

**Inputs**

| Field                    | Type            | Required | Description                                                                                            |
| ------------------------ | --------------- | -------- | ------------------------------------------------------------------------------------------------------ |
| Organization slug        | string          | No       | Organization for the App picker. Defaults to the connection organization.                              |
| App                      | select (string) | Yes      | The Fly App whose Machines you want to list. Options load from the selected connection.                |
| Include deleted Machines | boolean         | No       | Include Machines that have been deleted. Default: false.                                               |
| Region                   | string          | No       | Only return Machines in this Fly.io region.                                                            |
| States                   | string          | No       | Only return Machines in these states.                                                                  |
| Result limit             | integer         | No       | Target number of results, from 1 to 1000. The complete final page may exceed this count. Default: 100. |
| Continuation cursor      | string          | No       | Continue from the previous result using the same filters.                                              |

**Outputs**

| Field         | Type          | Description                                                              |
| ------------- | ------------- | ------------------------------------------------------------------------ |
| Machines      | object\_array | The Machines in the Fly App.                                             |
| Machine count | integer       | The number of Machines returned.                                         |
| Next cursor   | string        | Use this cursor to fetch more results. Empty means the list is complete. |

#### Get Machine

Get detailed state and configuration information for one Machine.

**Inputs**

| Field             | Type            | Required | Description                                                               |
| ----------------- | --------------- | -------- | ------------------------------------------------------------------------- |
| Organization slug | string          | No       | Organization for the App picker. Defaults to the connection organization. |
| App               | select (string) | Yes      | The App that owns the Machine. Options load from the selected connection. |
| Machine           | select (string) | Yes      | The Machine to inspect. Options load from the selected connection.        |

**Outputs**

| Field      | Type   | Description                                                                        |
| ---------- | ------ | ---------------------------------------------------------------------------------- |
| Machine    | object | The machine state and resource configuration, without environment values or files. |
| Machine ID | string | The Machine's stable ID.                                                           |
| State      | string | The Machine's current lifecycle state.                                             |

#### Start Machine

Request a machine start. Running machines incur compute charges.

**Inputs**

| Field             | Type            | Required | Description                                                                           |
| ----------------- | --------------- | -------- | ------------------------------------------------------------------------------------- |
| Organization slug | string          | No       | Organization for the App picker. Defaults to the connection organization.             |
| App               | select (string) | Yes      | The App that owns the Machine. Options load from the selected connection.             |
| Machine           | select (string) | Yes      | The stopped or suspended Machine to start. Options load from the selected connection. |

**Outputs**

| Field          | Type    | Description                                                |
| -------------- | ------- | ---------------------------------------------------------- |
| Machine ID     | string  | The Machine that received the start request.               |
| Previous state | string  | The Machine state before the start request, when returned. |
| Migrated       | boolean | Whether Fly.io migrated the Machine while starting it.     |
| New host       | string  | The Machine's new host after migration, when returned.     |

#### Create App

Create an empty Fly App in the connected organization.

**Inputs**

| Field    | Type   | Required | Description                                                     |
| -------- | ------ | -------- | --------------------------------------------------------------- |
| App name | string | Yes      | A unique app name using lowercase letters, numbers and hyphens. |

**Outputs**

| Field             | Type   | Description                                 |
| ----------------- | ------ | ------------------------------------------- |
| App ID            | string | The ID assigned by Fly.io.                  |
| App name          | string | The name requested for the new app.         |
| Organization slug | string | The organization where the app was created. |

#### Create Machine

Create a Machine from a public image. Stopped Machines still incur storage charges.

**Inputs**

| Field             | Type             | Required | Description                                                                                                   |
| ----------------- | ---------------- | -------- | ------------------------------------------------------------------------------------------------------------- |
| Organization slug | string           | No       | Organization for the App picker. Defaults to the connection organization.                                     |
| App               | select (string)  | Yes      | The App that will own the Machine. Options load from the selected connection.                                 |
| Machine name      | string           | Yes      | A unique name within the App, using lowercase letters, numbers or hyphens.                                    |
| Container image   | string           | Yes      | Public container image reference, including a tag or digest.                                                  |
| Start immediately | boolean          | No       | Start after creation and incur compute charges. Stopped Machines still incur storage charges. Default: false. |
| Memory            | select (integer) | No       | Memory allocation with one shared CPU. Available values: 256 MB, 512 MB, 1 GB. Default: 256.                  |
| Region            | string           | No       | Optional Fly.io region code; leave blank for provider placement.                                              |
| Command arguments | string           | No       | Optional command as a JSON array of arguments; leave blank to use the image default.                          |

**Outputs**

| Field      | Type   | Description                                           |
| ---------- | ------ | ----------------------------------------------------- |
| App name   | string | The App that owns the Machine.                        |
| Machine ID | string | The created Machine's stable ID.                      |
| State      | string | State returned during creation, when available.       |
| Machine    | object | Machine details with sensitive configuration omitted. |

#### Stop Machine

Request a machine stop. Stopped machines still incur root filesystem storage charges.

**Inputs**

| Field             | Type            | Required | Description                                                                                                               |
| ----------------- | --------------- | -------- | ------------------------------------------------------------------------------------------------------------------------- |
| Organization slug | string          | No       | Organization for the App picker. Defaults to the connection organization.                                                 |
| App               | select (string) | Yes      | The App that owns the Machine. Options load from the selected connection.                                                 |
| Machine           | select (string) | Yes      | The machine to stop. Stopping a suspended machine discards its saved snapshot. Options load from the selected connection. |

**Outputs**

| Field      | Type   | Description                                 |
| ---------- | ------ | ------------------------------------------- |
| Machine ID | string | The machine that received the stop request. |
| App name   | string | The app containing the machine.             |

### Important behavior

Actions that create, update, send, or delete data can change the connected service. Review their inputs before running them. A retry can repeat an operation; consider this when configuring retries for actions that change data.

The catalog lists the fields and capabilities available in the supplied provider definition. Availability can also depend on your deployment and organization’s Feature Access settings.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.stackai.com/integrations/catalog/fly.io.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
