# flyio OpenAPI overview

> Below is an overview of the flyio openapi in simple language. This API contains 98 endpoints.

For more detailed information of an endpoint, visit https://oapis.org/summary/flyio/[idOrRoute]

Machines API v1.0 - https://api.machines.dev
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/) for how to get started, more information about each endpoint, parameter descriptions, and examples.

## Apps

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.

- [Apps_list](https://oapis.org/openapi/flyio/Apps_list): GET https://api.machines.dev/v1/apps?org_slug=string&app_role=string - List Apps
- [Apps_create](https://oapis.org/openapi/flyio/Apps_create): POST https://api.machines.dev/v1/apps - Create App
- [Apps_show](https://oapis.org/openapi/flyio/Apps_show): GET https://api.machines.dev/v1/apps/{app_name} - Get App
- [Apps_delete](https://oapis.org/openapi/flyio/Apps_delete): DELETE https://api.machines.dev/v1/apps/{app_name} - Destroy App
- [App_create_deploy_token](https://oapis.org/openapi/flyio/App_create_deploy_token): POST https://api.machines.dev/v1/apps/{app_name}/deploy_token - Create App deploy token
- [App_IPAssignments_list](https://oapis.org/openapi/flyio/App_IPAssignments_list): GET https://api.machines.dev/v1/apps/{app_name}/ip_assignments - List IP assignments for app
- [App_IPAssignments_create](https://oapis.org/openapi/flyio/App_IPAssignments_create): POST https://api.machines.dev/v1/apps/{app_name}/ip_assignments - Assign new IP address to app
- [App_IPAssignments_delete](https://oapis.org/openapi/flyio/App_IPAssignments_delete): DELETE https://api.machines.dev/v1/apps/{app_name}/ip_assignments/{ip} - Remove IP assignment from app

## Machines

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/machines-resource/) for details about using the Machines resource.

- [Machines_list](https://oapis.org/openapi/flyio/Machines_list): GET https://api.machines.dev/v1/apps/{app_name}/machines?include_deleted=boolean&include_leases=boolean&region=string&state=string&summary=boolean&metadata.{key}=string - List Machines
- [Machines_create](https://oapis.org/openapi/flyio/Machines_create): POST https://api.machines.dev/v1/apps/{app_name}/machines - Create Machine
- [Machines_show](https://oapis.org/openapi/flyio/Machines_show): GET https://api.machines.dev/v1/apps/{app_name}/machines/{machine_id}?include_leases=boolean - Get Machine
- [Machines_update](https://oapis.org/openapi/flyio/Machines_update): POST https://api.machines.dev/v1/apps/{app_name}/machines/{machine_id} - Update Machine
- [Machines_delete](https://oapis.org/openapi/flyio/Machines_delete): DELETE https://api.machines.dev/v1/apps/{app_name}/machines/{machine_id}?force=boolean - Destroy Machine
- [Machines_cordon](https://oapis.org/openapi/flyio/Machines_cordon): POST https://api.machines.dev/v1/apps/{app_name}/machines/{machine_id}/cordon - Cordon Machine
- [Machines_list_events](https://oapis.org/openapi/flyio/Machines_list_events): GET https://api.machines.dev/v1/apps/{app_name}/machines/{machine_id}/events?limit=integer - List Events
- [Machines_exec](https://oapis.org/openapi/flyio/Machines_exec): POST https://api.machines.dev/v1/apps/{app_name}/machines/{machine_id}/exec - Execute Command
- [Machines_show_lease](https://oapis.org/openapi/flyio/Machines_show_lease): GET https://api.machines.dev/v1/apps/{app_name}/machines/{machine_id}/lease - Get Lease
- [Machines_create_lease](https://oapis.org/openapi/flyio/Machines_create_lease): POST https://api.machines.dev/v1/apps/{app_name}/machines/{machine_id}/lease - Create Lease
- [Machines_release_lease](https://oapis.org/openapi/flyio/Machines_release_lease): DELETE https://api.machines.dev/v1/apps/{app_name}/machines/{machine_id}/lease - Release Lease
- [Machines_get_memory](https://oapis.org/openapi/flyio/Machines_get_memory): GET https://api.machines.dev/v1/apps/{app_name}/machines/{machine_id}/memory - Get Machine Memory
- [Machines_set_memory_limit](https://oapis.org/openapi/flyio/Machines_set_memory_limit): PUT https://api.machines.dev/v1/apps/{app_name}/machines/{machine_id}/memory - Set Machine Memory Limit
- [Machines_reclaim_memory](https://oapis.org/openapi/flyio/Machines_reclaim_memory): POST https://api.machines.dev/v1/apps/{app_name}/machines/{machine_id}/memory/reclaim - Reclaim Machine Memory
- [Machines_show_metadata](https://oapis.org/openapi/flyio/Machines_show_metadata): GET https://api.machines.dev/v1/apps/{app_name}/machines/{machine_id}/metadata - Get Metadata
- [Machines_update_metadata](https://oapis.org/openapi/flyio/Machines_update_metadata): PUT https://api.machines.dev/v1/apps/{app_name}/machines/{machine_id}/metadata - Update Metadata (set/remove multiple keys)
- [Machines_update_metadata](https://oapis.org/openapi/flyio/Machines_update_metadata): PATCH https://api.machines.dev/v1/apps/{app_name}/machines/{machine_id}/metadata - Update Metadata (set/remove multiple keys)
- [Machines_get_metadata_key](https://oapis.org/openapi/flyio/Machines_get_metadata_key): GET https://api.machines.dev/v1/apps/{app_name}/machines/{machine_id}/metadata/{key} - Get Metadata Value
- [Machines_upsert_metadata](https://oapis.org/openapi/flyio/Machines_upsert_metadata): POST https://api.machines.dev/v1/apps/{app_name}/machines/{machine_id}/metadata/{key} - Upsert Metadata Key
- [Machines_delete_metadata](https://oapis.org/openapi/flyio/Machines_delete_metadata): DELETE https://api.machines.dev/v1/apps/{app_name}/machines/{machine_id}/metadata/{key} - Delete Metadata
- [Machines_list_processes](https://oapis.org/openapi/flyio/Machines_list_processes): GET https://api.machines.dev/v1/apps/{app_name}/machines/{machine_id}/ps?sort_by=string&order=string - List Processes
- [Machines_restart](https://oapis.org/openapi/flyio/Machines_restart): POST https://api.machines.dev/v1/apps/{app_name}/machines/{machine_id}/restart?timeout=string&signal=string - Restart Machine
- [Machines_signal](https://oapis.org/openapi/flyio/Machines_signal): POST https://api.machines.dev/v1/apps/{app_name}/machines/{machine_id}/signal - Signal Machine
- [Machines_start](https://oapis.org/openapi/flyio/Machines_start): POST https://api.machines.dev/v1/apps/{app_name}/machines/{machine_id}/start - Start Machine
- [Machines_stop](https://oapis.org/openapi/flyio/Machines_stop): POST https://api.machines.dev/v1/apps/{app_name}/machines/{machine_id}/stop - Stop Machine
- [Machines_suspend](https://oapis.org/openapi/flyio/Machines_suspend): POST https://api.machines.dev/v1/apps/{app_name}/machines/{machine_id}/suspend - Suspend Machine
- [Machines_uncordon](https://oapis.org/openapi/flyio/Machines_uncordon): POST https://api.machines.dev/v1/apps/{app_name}/machines/{machine_id}/uncordon - Uncordon Machine
- [Machines_list_versions](https://oapis.org/openapi/flyio/Machines_list_versions): GET https://api.machines.dev/v1/apps/{app_name}/machines/{machine_id}/versions - List Versions
- [Machines_wait](https://oapis.org/openapi/flyio/Machines_wait): GET https://api.machines.dev/v1/apps/{app_name}/machines/{machine_id}/wait?version=string&instance_id=string&from_event_id=string&timeout=integer&state=string - Wait for State

## Organizations

- [Machines_org_list](https://oapis.org/openapi/flyio/Machines_org_list): GET https://api.machines.dev/v1/orgs/{org_slug}/machines?include_deleted=boolean&region=string&state=string&summary=boolean&updated_after=string&cursor=string&limit=integer - List All Machines
- [Volumes_org_list](https://oapis.org/openapi/flyio/Volumes_org_list): GET https://api.machines.dev/v1/orgs/{org_slug}/volumes?include_deleted=boolean&region=string&state=string&summary=boolean&updated_after=string&cursor=string&limit=integer - List All Volumes

## Platform

- [Platform_placements_post](https://oapis.org/openapi/flyio/Platform_placements_post): POST https://api.machines.dev/v1/platform/placements - Get Placements
- [Platform_regions_get](https://oapis.org/openapi/flyio/Platform_regions_get): GET https://api.machines.dev/v1/platform/regions - Get Regions

## Postgres Clusters

Create and manage Postgres clusters, including databases, users, extensions, backups, and app attachments.

- [Postgres_list](https://oapis.org/openapi/flyio/Postgres_list): GET https://api.machines.dev/v1/postgres?org_slug=string&include_deleted=boolean - List Postgres Clusters
- [Postgres_create](https://oapis.org/openapi/flyio/Postgres_create): POST https://api.machines.dev/v1/postgres - Create Postgres Cluster
- [Postgres_show](https://oapis.org/openapi/flyio/Postgres_show): GET https://api.machines.dev/v1/postgres/{postgres_cluster_id} - Get Postgres Cluster
- [Postgres_delete](https://oapis.org/openapi/flyio/Postgres_delete): DELETE https://api.machines.dev/v1/postgres/{postgres_cluster_id} - Delete Postgres Cluster
- [Postgres_attachments_create](https://oapis.org/openapi/flyio/Postgres_attachments_create): POST https://api.machines.dev/v1/postgres/{postgres_cluster_id}/attachments - Attach Cluster to App
- [Postgres_attachments_delete](https://oapis.org/openapi/flyio/Postgres_attachments_delete): DELETE https://api.machines.dev/v1/postgres/{postgres_cluster_id}/attachments/{app_name} - Detach Cluster from App
- [Postgres_backups_list](https://oapis.org/openapi/flyio/Postgres_backups_list): GET https://api.machines.dev/v1/postgres/{postgres_cluster_id}/backups - List Backups
- [Postgres_backups_create](https://oapis.org/openapi/flyio/Postgres_backups_create): POST https://api.machines.dev/v1/postgres/{postgres_cluster_id}/backups - Create Backup
- [Postgres_databases_list](https://oapis.org/openapi/flyio/Postgres_databases_list): GET https://api.machines.dev/v1/postgres/{postgres_cluster_id}/databases - List Databases
- [Postgres_databases_create](https://oapis.org/openapi/flyio/Postgres_databases_create): POST https://api.machines.dev/v1/postgres/{postgres_cluster_id}/databases - Create Database
- [Postgres_databases_delete](https://oapis.org/openapi/flyio/Postgres_databases_delete): DELETE https://api.machines.dev/v1/postgres/{postgres_cluster_id}/databases/{database_name} - Drop Database
- [Postgres_extensions_list](https://oapis.org/openapi/flyio/Postgres_extensions_list): GET https://api.machines.dev/v1/postgres/{postgres_cluster_id}/databases/{database_name}/extensions - List Extensions
- [Postgres_extensions_enable](https://oapis.org/openapi/flyio/Postgres_extensions_enable): POST https://api.machines.dev/v1/postgres/{postgres_cluster_id}/databases/{database_name}/extensions - Enable Extension
- [Postgres_extensions_disable](https://oapis.org/openapi/flyio/Postgres_extensions_disable): DELETE https://api.machines.dev/v1/postgres/{postgres_cluster_id}/databases/{database_name}/extensions/{extension_name}?force=boolean - Disable Extension
- [Postgres_fork](https://oapis.org/openapi/flyio/Postgres_fork): POST https://api.machines.dev/v1/postgres/{postgres_cluster_id}/fork - Fork Cluster to New Cluster
- [Postgres_restore](https://oapis.org/openapi/flyio/Postgres_restore): POST https://api.machines.dev/v1/postgres/{postgres_cluster_id}/restore - Restore Backup or Point in Time to New Cluster
- [Postgres_users_list](https://oapis.org/openapi/flyio/Postgres_users_list): GET https://api.machines.dev/v1/postgres/{postgres_cluster_id}/users - List Users
- [Postgres_users_create](https://oapis.org/openapi/flyio/Postgres_users_create): POST https://api.machines.dev/v1/postgres/{postgres_cluster_id}/users - Create User
- [Postgres_users_update_role](https://oapis.org/openapi/flyio/Postgres_users_update_role): PATCH https://api.machines.dev/v1/postgres/{postgres_cluster_id}/users/{username} - Update User Role
- [Postgres_users_delete](https://oapis.org/openapi/flyio/Postgres_users_delete): DELETE https://api.machines.dev/v1/postgres/{postgres_cluster_id}/users/{username} - Delete User
- [Postgres_users_credentials](https://oapis.org/openapi/flyio/Postgres_users_credentials): GET https://api.machines.dev/v1/postgres/{postgres_cluster_id}/users/{username}/credentials - Get User Credentials
- [Postgres_users_rotate_password](https://oapis.org/openapi/flyio/Postgres_users_rotate_password): POST https://api.machines.dev/v1/postgres/{postgres_cluster_id}/users/{username}/rotate_password - Rotate User Password

## Secrets

- [Secretkeys_list](https://oapis.org/openapi/flyio/Secretkeys_list): GET https://api.machines.dev/v1/apps/{app_name}/secretkeys?min_version=string&types=string - List secret keys belonging to an app
- [Secretkey_get](https://oapis.org/openapi/flyio/Secretkey_get): GET https://api.machines.dev/v1/apps/{app_name}/secretkeys/{secret_name}?min_version=string - Get an app's secret key
- [Secretkey_set](https://oapis.org/openapi/flyio/Secretkey_set): POST https://api.machines.dev/v1/apps/{app_name}/secretkeys/{secret_name} - Create or update a secret key
- [Secretkey_delete](https://oapis.org/openapi/flyio/Secretkey_delete): DELETE https://api.machines.dev/v1/apps/{app_name}/secretkeys/{secret_name} - Delete an app's secret key
- [Secretkey_decrypt](https://oapis.org/openapi/flyio/Secretkey_decrypt): POST https://api.machines.dev/v1/apps/{app_name}/secretkeys/{secret_name}/decrypt?min_version=string - Decrypt with a secret key
- [Secretkey_encrypt](https://oapis.org/openapi/flyio/Secretkey_encrypt): POST https://api.machines.dev/v1/apps/{app_name}/secretkeys/{secret_name}/encrypt?min_version=string - Encrypt with a secret key
- [Secretkey_generate](https://oapis.org/openapi/flyio/Secretkey_generate): POST https://api.machines.dev/v1/apps/{app_name}/secretkeys/{secret_name}/generate - Generate a random secret key
- [Secretkey_sign](https://oapis.org/openapi/flyio/Secretkey_sign): POST https://api.machines.dev/v1/apps/{app_name}/secretkeys/{secret_name}/sign?min_version=string - Sign with a secret key
- [Secretkey_verify](https://oapis.org/openapi/flyio/Secretkey_verify): POST https://api.machines.dev/v1/apps/{app_name}/secretkeys/{secret_name}/verify?min_version=string - Verify with a secret key
- [Secrets_list](https://oapis.org/openapi/flyio/Secrets_list): GET https://api.machines.dev/v1/apps/{app_name}/secrets?min_version=string&show_secrets=boolean - List app secrets belonging to an app
- [Secrets_update](https://oapis.org/openapi/flyio/Secrets_update): POST https://api.machines.dev/v1/apps/{app_name}/secrets - Update app secrets belonging to an app
- [Secret_get](https://oapis.org/openapi/flyio/Secret_get): GET https://api.machines.dev/v1/apps/{app_name}/secrets/{secret_name}?min_version=string&show_secrets=boolean - Get an app secret
- [Secret_create](https://oapis.org/openapi/flyio/Secret_create): POST https://api.machines.dev/v1/apps/{app_name}/secrets/{secret_name} - Create or update Secret
- [Secret_delete](https://oapis.org/openapi/flyio/Secret_delete): DELETE https://api.machines.dev/v1/apps/{app_name}/secrets/{secret_name} - Delete an app secret

## TLS Certificates

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/certificates-resource/) for details about using the TLS Certificates resource.


- [App_Certificates_list](https://oapis.org/openapi/flyio/App_Certificates_list): GET https://api.machines.dev/v1/apps/{app_name}/certificates?filter=string&cursor=string&limit=integer - List certificates for app
- [App_Certificates_acme_create](https://oapis.org/openapi/flyio/App_Certificates_acme_create): POST https://api.machines.dev/v1/apps/{app_name}/certificates/acme - Request ACME certificate
- [App_Certificates_custom_create](https://oapis.org/openapi/flyio/App_Certificates_custom_create): POST https://api.machines.dev/v1/apps/{app_name}/certificates/custom - Upload custom certificate
- [App_Certificates_show](https://oapis.org/openapi/flyio/App_Certificates_show): GET https://api.machines.dev/v1/apps/{app_name}/certificates/{hostname} - Get certificate details
- [App_Certificates_delete](https://oapis.org/openapi/flyio/App_Certificates_delete): DELETE https://api.machines.dev/v1/apps/{app_name}/certificates/{hostname} - Remove certificate
- [App_Certificates_acme_delete](https://oapis.org/openapi/flyio/App_Certificates_acme_delete): DELETE https://api.machines.dev/v1/apps/{app_name}/certificates/{hostname}/acme - Remove ACME certificates
- [App_Certificates_check](https://oapis.org/openapi/flyio/App_Certificates_check): POST https://api.machines.dev/v1/apps/{app_name}/certificates/{hostname}/check - Check DNS and re-validate certificate
- [App_Certificates_custom_delete](https://oapis.org/openapi/flyio/App_Certificates_custom_delete): DELETE https://api.machines.dev/v1/apps/{app_name}/certificates/{hostname}/custom - Remove custom certificate

## Tokens

- [Tokens_authenticate](https://oapis.org/openapi/flyio/Tokens_authenticate): POST https://api.machines.dev/v1/tokens/authenticate - Authenticate token header
- [Tokens_authorize](https://oapis.org/openapi/flyio/Tokens_authorize): POST https://api.machines.dev/v1/tokens/authorize - Authorize token for resource access
- [CurrentToken_show](https://oapis.org/openapi/flyio/CurrentToken_show): GET https://api.machines.dev/v1/tokens/current - Get Current Token Information
- [Tokens_request_Kms](https://oapis.org/openapi/flyio/Tokens_request_Kms): POST https://api.machines.dev/v1/tokens/kms - Request a Petsem token for accessing KMS
- [Tokens_request_OIDC](https://oapis.org/openapi/flyio/Tokens_request_OIDC): POST https://api.machines.dev/v1/tokens/oidc - Request an OIDC token

## Volumes

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/volumes-resource/) for details about using the Volumes resource.

- [Volumes_list](https://oapis.org/openapi/flyio/Volumes_list): GET https://api.machines.dev/v1/apps/{app_name}/volumes?summary=boolean - List Volumes
- [Volumes_create](https://oapis.org/openapi/flyio/Volumes_create): POST https://api.machines.dev/v1/apps/{app_name}/volumes - Create Volume
- [Volumes_get_by_id](https://oapis.org/openapi/flyio/Volumes_get_by_id): GET https://api.machines.dev/v1/apps/{app_name}/volumes/{volume_id} - Get Volume
- [Volumes_update](https://oapis.org/openapi/flyio/Volumes_update): PUT https://api.machines.dev/v1/apps/{app_name}/volumes/{volume_id} - Update Volume
- [Volume_delete](https://oapis.org/openapi/flyio/Volume_delete): DELETE https://api.machines.dev/v1/apps/{app_name}/volumes/{volume_id} - Destroy Volume
- [Volumes_extend](https://oapis.org/openapi/flyio/Volumes_extend): PUT https://api.machines.dev/v1/apps/{app_name}/volumes/{volume_id}/extend - Extend Volume
- [Volumes_list_snapshots](https://oapis.org/openapi/flyio/Volumes_list_snapshots): GET https://api.machines.dev/v1/apps/{app_name}/volumes/{volume_id}/snapshots - List Snapshots
- [createVolumeSnapshot](https://oapis.org/openapi/flyio/createVolumeSnapshot): POST https://api.machines.dev/v1/apps/{app_name}/volumes/{volume_id}/snapshots - Create Snapshot