Fly

Request ACME certificate

Remove ACME certificates

Check DNS and re-validate certificate

Upload custom certificate

Remove custom certificate

Remove certificate

List certificates for app

Get certificate details

Create App deploy token

Assign new IP address to app

Remove IP assignment from app

List IP assignments for app

Create an app with the specified details in the request body.

Delete an app by its name.

List all apps with the ability to filter by organization slug.

Retrieve details about a specific app by its name.

Create a snapshot for a specific volume within an app.

Get information about the current macaroon token(s), including organizations, apps, user identity hashes, and machine restrictions

“Cordoning” a Machine refers to disabling its services, so the Fly Proxy won’t route requests to it. In flyctl this is used by blue/green deployments; one set of Machines is started up with services disabled, and when they are all healthy, the services are enabled on the new Machines and disabled on the old ones.

Create a Machine within a specific app using the details provided in the request body. **Important**: This request can fail, and you’re responsible for handling that failure. If you ask for a large Machine, or a Machine in a region we happen to be at capacity for, you might need to retry the request, or to fall back to another region. If you’re working directly with the Machines API, you’re taking some responsibility for your own orchestration!

Create a lease for a specific Machine within an app using the details provided in the request body. Machine leases can be used to obtain an exclusive lock on modifying a Machine.

Delete a specific Machine within an app by Machine ID, with an optional force parameter to force kill the Machine if it's running.

Delete metadata for a specific Machine within an app by providing a metadata key.

Execute a command on a specific Machine and return the raw command output bytes.

Get current memory limit and available capacity for a machine

Get the value of a specific metadata key

List all Machines associated with a specific app, with optional filters for including deleted Machines and filtering by region.

List all events associated with a specific Machine within an app.

List all processes running on a specific Machine within an app, with optional sorting parameters.

List all versions of the configuration for a specific Machine within an app.

List all Machines associated with a specific organization. Machines are sorted by their `updated_at` timestamps, oldest to newest. This API call represents "a point in time". Recent machine changes, including creations and destructions, may take time to propagate. When polling with `updated_after`, offset your timestamps to catch late-arriving events.

Trigger the balloon device to reclaim memory from a machine

Release the lease of a specific Machine within an app. Machine leases can be used to obtain an exclusive lock on modifying a Machine.

Restart a specific Machine within an app, with an optional timeout parameter.

Set the memory limit for a machine using the balloon device

Get details of a specific Machine within an app by the Machine ID.

Retrieve the current lease of a specific Machine within an app. Machine leases can be used to obtain an exclusive lock on modifying a Machine.

Retrieve metadata for a specific Machine within an app.

Send a signal to a specific Machine within an app using the details provided in the request body.

Start a specific Machine within an app.

Stop a specific Machine within an app, with an optional request body to specify signal and timeout.

Suspend a specific Machine within an app. The next start operation will attempt (but is not guaranteed) to resume the Machine from a snapshot taken at suspension time, rather than performing a cold boot.

“Cordoning” a Machine refers to disabling its services, so the Fly Proxy won’t route requests to it. In flyctl this is used by blue/green deployments; one set of Machines is started up with services disabled, and when they are all healthy, the services are enabled on the new Machines and disabled on the old ones.

Update a Machine's configuration using the details provided in the request body.

Update multiple metadata keys at once. Null values and empty strings remove keys. + If `machine_version` is provided and no longer matches the current machine version, returns 412 Precondition Failed.

Update metadata for a specific machine within an app by providing a metadata key.

Wait for a Machine to reach a specific state. Specify the desired state with the state parameter. See the [Machine states table](https://fly.io/docs/machines/working-with-machines/#machine-states) for a list of possible states. The default for this parameter is `started`. This request will block for up to 60 seconds. Set a shorter timeout with the timeout parameter.

Update multiple metadata keys at once. Null values and empty strings remove keys. + If `machine_version` is provided and no longer matches the current machine version, returns 412 Precondition Failed.

Simulates placing the specified number of machines into regions, depending on available capacity and limits.

List all regions on the platform with their details.

Attach a specific cluster to a Fly app. The attachment is created if it does not already exist.

Detach a specific cluster from a Fly app.

Create a backup for a specific cluster. The backup runs asynchronously and is rejected if one is already in progress.

List all backups associated with a specific cluster.

Create a Managed Postgres cluster for the organization named in the request body. Provisioning is asynchronous, and a name is generated when one is not supplied.

Create a database within a specific cluster.

Delete a specific database within a cluster, along with objects that depend on it.

List all databases within a specific cluster.

Delete a Managed Postgres cluster. The cluster is marked for deletion and removed asynchronously.

Disable a specific Postgres extension within a database, optionally dropping objects that depend on it. System extensions cannot be disabled.

Enable a Postgres extension within a specific database. PostGIS extensions require a PostGIS-enabled cluster.

List all extensions available within a specific database, indicating which are installed.

Fork a ready Managed Postgres cluster into a new cluster that inherits the source's settings. The source cluster is left unchanged, and the fork is provisioned asynchronously.

List Managed Postgres clusters for an organization.

Restore a backup into a new Managed Postgres cluster. The source cluster is left unchanged, and a new cluster is provisioned from the specified backup.

Get details of a specific Managed Postgres cluster.

Create a Postgres user within a specific cluster. Fetch the generated password from the credentials endpoint.

Get the connection credentials for a specific Postgres user within a cluster.

Delete a specific Postgres user within a cluster.

List all Postgres users within a specific cluster.

Rotate a specific Postgres user's password within a cluster, optionally terminating the user's existing sessions.

Update a specific Postgres user's role within a cluster.

Create or update Secret

Delete an app secret

Get an app secret

Decrypt with a secret key

Delete an app's secret key

Encrypt with a secret key

Generate a random secret key

Get an app's secret key

Create or update a secret key

Sign with a secret key

Verify with a secret key

List secret keys belonging to an app

List app secrets belonging to an app

Update app secrets belonging to an app

Verify a token header without checking resource access.

Verify a token header and validate it against a requested access scope.

This site hosts documentation generated from the Fly.io Machines API OpenAPI specification. Visit our complete [Machines API docs](https://fly.io/docs/machines/api/apps-resource/) for details about using the Apps resource.

Request an Open ID Connect token for your machine. Customize the audience claim with the `aud` parameter. This returns a JWT token. Learn more about [using OpenID Connect](/docs/reference/openid-connect/) on Fly.io.

Delete a specific volume within an app by volume ID.

Create a volume for a specific app using the details provided in the request body.

Extend a volume's size within an app using the details provided in the request body.

Retrieve details about a specific volume by its ID within an app.

List all volumes associated with a specific app.

List all snapshots for a specific volume within an app.

List all volumes for an organization with optional filters and cursor-based pagination.

Update a volume's configuration using the details provided in the request body.