> ## Documentation Index
> Fetch the complete documentation index at: https://docs.boxd.sh/llms.txt
> Use this file to discover all available pages before exploring further.

# Fly.io

> Fly.io transforms containers into micro-VMs that run on hardware in 30+ regions on six continents

Fly.io transforms containers into micro-VMs that run on hardware in 30+ regions on six continents.

`fly` · **45 tools** · no triggers

## Connect it

```bash theme={"theme":"github-dark"}
run auth fly
run auth fly --scope team    # shared with the organization
```

Or from the [Integrations page](https://app.boxd.sh/integrations) in the console. See [Connections](/guides/integrations/connections) for personal versus shared, and who may remove one.

## Use it

```bash theme={"theme":"github-dark"}
run fly          # common commands
run fly --all    # every command
```

```ts theme={"theme":"github-dark"}
import { fly } from "@boxd/run";
```

## Common tools

| Tool                        | What it does                                                                                                                 |
| --------------------------- | ---------------------------------------------------------------------------------------------------------------------------- |
| `get-app-details`           | Tool to retrieve detailed information about a specific Fly.io application.                                                   |
| `get-current-token-info`    | Tool to get information about the current authentication token.                                                              |
| `get-machine`               | Tool to get a single machine by ID from Fly.io. Use when you need to retrieve details about a specific machine instance.     |
| `get-organization`          | Tool to find a Fly.io organization by slug using the GraphQL API.                                                            |
| `get-personal-organization` | Tool to retrieve the user's personal organization details from Fly.io.                                                       |
| `get-placements`            | Tool to get placement recommendations for Machines in Fly.io regions.                                                        |
| `get-platform-info`         | Tool to retrieve Fly.io platform information including available regions, VM sizes, and flyctl version.                      |
| `get-regions`               | Tool to get the list of available Fly.io regions with optional filtering.                                                    |
| `get-viewer-info`           | Tool to retrieve the authenticated user's account information from Fly.io.                                                   |
| `list-apps`                 | Tool to list all Fly Apps in an organization. Use when you need to retrieve apps for a specific organization using its slug. |
| `list-apps-graphql`         | List all Fly.io applications with details including volumes, services, and VMs using GraphQL.                                |
| `list-machines`             | Tool to list Fly.io machines using GraphQL API with pagination support.                                                      |
| `list-org-machines`         | Tool to list all Machines across all apps in a Fly organization.                                                             |

<Accordion title="All 45 tools" icon="list">
  | Tool                                | What it does                                                                                                                                                |
  | ----------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- |
  | `add-wire-guard-peer`               | Tool to add a WireGuard peer connection to a Fly.io organization for private network access.                                                                |
  | `check-app-name-availability`       | Tool to validate an app name for Fly.io app creation. Use when you need to check if a proposed app name is available before attempting to create a new app. |
  | `check-jobs`                        | Execute GraphQL queries against the Fly.io checkJobs endpoint.                                                                                              |
  | `check-user-only-token`             | Check whether the authentication token only allows user access.                                                                                             |
  | `create-check-job`                  | Tool to create a health check job for monitoring application endpoints in Fly.io.                                                                           |
  | `create-check-job-run`              | Triggers a run of an existing health check job on Fly.io. Use when you need to manually trigger a health check for monitoring or testing purposes.          |
  | `create-delegated-wire-guard-token` | Tool to create a delegated WireGuard token for peer management in a Fly.io organization.                                                                    |
  | `create-third-party-configuration`  | Tool to create a third-party service configuration for discharging macaroon caveats.                                                                        |
  | `delete-delegated-wire-guard-token` | Tool to delete a delegated WireGuard token from a Fly.io organization.                                                                                      |
  | `delete-organization`               | Tool to delete a Fly.io organization and all its associated resources using the GraphQL API.                                                                |
  | `delete-remote-builder`             | Tool to delete a remote builder configuration for a Fly.io organization.                                                                                    |
  | `delete-third-party-configuration`  | Tool to delete a third-party service configuration from Fly.io.                                                                                             |
  | `detach-postgres-cluster`           | Tool to detach a Postgres cluster from a Fly.io application, revoking access credentials.                                                                   |
  | `establish-ssh-key`                 | Tool to establish an SSH key for a Fly.io organization. Use when setting up SSH access for secure connections to Fly.io infrastructure.                     |
  | `fetch-nodes-by-ids`                | Fetches a list of node objects from Fly.io given a list of IDs using the GraphQL nodes query.                                                               |
  | `get-add-on`                        | Tool to find a Fly.io add-on by ID, name, or provider. Use when you need to retrieve details about a specific add-on.                                       |
  | `get-add-on-provider`               | Tool to query information about a specific Fly.io add-on provider (extension) by name.                                                                      |
  | `get-app-details`                   | Tool to retrieve detailed information about a specific Fly.io application.                                                                                  |
  | `get-certificate`                   | Tool to retrieve a certificate by its ID from Fly.io. Use when you need to get details about a specific certificate including hostname, creation...         |
  | `get-current-token-info`            | Tool to get information about the current authentication token.                                                                                             |
  | `get-latest-image-details`          | Tool to retrieve the latest available tag details for a given image repository from Fly.io's registry.                                                      |
  | `get-latest-image-tag`              | Tool to retrieve the latest available image tag for a Fly.io Docker repository.                                                                             |
  | `get-machine`                       | Tool to get a single machine by ID from Fly.io. Use when you need to retrieve details about a specific machine instance.                                    |
  | `get-nearest-region`                | Tool to retrieve the nearest Fly.io region to the requesting client based on network location.                                                              |
  | `get-node`                          | Tool to fetch an object by its globally unique ID using Fly.io's GraphQL node query.                                                                        |
  | `get-organization`                  | Tool to find a Fly.io organization by slug using the GraphQL API.                                                                                           |
  | `get-personal-organization`         | Tool to retrieve the user's personal organization details from Fly.io.                                                                                      |
  | `get-placements`                    | Tool to get placement recommendations for Machines in Fly.io regions.                                                                                       |
  | `get-platform-info`                 | Tool to retrieve Fly.io platform information including available regions, VM sizes, and flyctl version.                                                     |
  | `get-products`                      | Tool to retrieve Fly.io product and price information via GraphQL.                                                                                          |
  | `get-regions`                       | Tool to get the list of available Fly.io regions with optional filtering.                                                                                   |
  | `get-viewer-info`                   | Tool to retrieve the authenticated user's account information from Fly.io.                                                                                  |
  | `issue-certificate`                 | Tool to issue an SSH certificate for accessing Fly.io infrastructure.                                                                                       |
  | `list-add-on-plans`                 | Tool to list available add-on service plans from Fly.io. Use when you need to discover pricing, features, and resource limits for Fly.io add-on services.   |
  | `list-add-ons`                      | Tool to list add-ons associated with an organization in Fly.io.                                                                                             |
  | `list-apps`                         | Tool to list all Fly Apps in an organization. Use when you need to retrieve apps for a specific organization using its slug.                                |
  | `list-apps-graphql`                 | List all Fly.io applications with details including volumes, services, and VMs using GraphQL.                                                               |
  | `list-check-locations`              | Retrieve all available Fly.io health check locations. Returns a comprehensive list of global locations where health checks can be performed...              |
  | `list-machines`                     | Tool to list Fly.io machines using GraphQL API with pagination support.                                                                                     |
  | `list-org-machines`                 | Tool to list all Machines across all apps in a Fly organization.                                                                                            |
  | `remove-wire-guard-peer`            | Tool to remove a WireGuard peer connection from a Fly.io organization.                                                                                      |
  | `set-apps-v2-default-on`            | Tool to configure whether new apps in an organization use Apps V2 by default on Fly.io.                                                                     |
  | `update-third-party-configuration`  | Tool to update an existing third-party service configuration for discharging macaroon caveats.                                                              |
  | `validate-config`                   | Tool to validate a Fly.io app configuration. Use when you need to check if a fly.toml configuration is valid before deploying or updating an app.           |
  | `validate-wire-guard-peers`         | Tool to validate WireGuard peer IP addresses in a Fly.io organization.                                                                                      |
</Accordion>

[Open Fly.io in the console →](https://app.boxd.sh/integrations/detail/fly)
