Skip to main content
These are the data models used across the Machines API requests and responses, generated from the OpenAPI specification.

AcmeChallenge

App

AppOrganizationInfo

AppSecret

AppSecrets

AppSecretsUpdateRequest

AppSecretsUpdateResp

assignIPRequest

authenticateTokenRequest

authorizeResponse

authorizeTokenRequest

CertificateCheckResponse

CertificateDetail

CertificateEntry

CertificateSummary

CertificateValidation

CertificateValidationError

CheckStatus

createAcmeCertificateRequest

CreateAppDeployTokenRequest

CreateAppRequest

CreateAppResponse

createCustomCertificateRequest

CreateLeaseRequest

CreateMachineRequest

CreateOIDCTokenRequest

Optional parameters

createPostgresAttachmentRequest

createPostgresAttachmentResponse

createPostgresBackupRequest

createPostgresClusterRequest

createPostgresDatabaseRequest

createPostgresUserRequest

createPostgresUserResponse

CreateVolumeRequest

CurrentTokenResponse

DecryptSecretkeyRequest

DecryptSecretkeyResponse

DeleteAppSecretResponse

DeleteSecretkeyResponse

destroyCustomCertificateResponse

DNSRecords

DNSRequirements

enablePostgresExtensionRequest

EncryptSecretkeyRequest

EncryptSecretkeyResponse

ErrorResponse

ExtendVolumeRequest

ExtendVolumeResponse

fly.ContainerConfig

fly.ContainerDependency

fly.ContainerDependencyCondition

Type: string

fly.ContainerHealthcheck

fly.ContainerHealthcheckKind

Type: string

fly.ContainerHealthcheckScheme

Type: string

fly.DNSConfig

fly.dnsForwardRule

fly.dnsOption

fly.EnvFrom

EnvVar defines an environment variable to be populated from a machine field, env_var

fly.ExecHealthcheck

fly.File

A file that will be written to the Machine. One of RawValue or SecretName must be set.

fly.HTTPHealthcheck

fly.HTTPOptions

fly.HTTPResponseOptions

fly.MachineCacheDrive

fly.MachineCheck

fly.MachineConfig

fly.MachineGuest

fly.MachineHTTPHeader

For http checks, an array of objects with string field Name and array of strings field Values. The key/value pairs specify header and header values that will get passed with the check call.

fly.MachineInit

fly.MachineMetrics

fly.MachineMount

fly.MachinePort

fly.MachineProcess

fly.MachineRestart

The Machine restart policy defines whether and how flyd restarts a Machine after its main process exits. See https://fly.io/docs/machines/guides-examples/machine-restart-policy/.

fly.MachineRootfs

fly.MachineSecret

A Secret needing to be set in the environment of the Machine. env_var is required

fly.MachineService

fly.MachineServiceCheck

fly.MachineServiceConcurrency

fly.MachineSpot

fly.ProxyProtoOptions

fly.ReplayCache

fly.Static

fly.StopConfig

fly.TCPHealthcheck

fly.TLSOptions

fly.UnhealthyPolicy

Type: string

flydv1.ExecResponse

flyio.Access

forkPostgresClusterRequest

getPostgresUserCredentialsResponse

ImageRef

IPAssignment

IssuedCertificate

Lease

ListAppsResponse

listCertificatesResponse

ListenSocket

listIPAssignmentsResponse

listPostgresBackupsResponse

listPostgresClustersResponse

listPostgresDatabasesResponse

listPostgresExtensionsResponse

listPostgresUsersResponse

macaroon.CaveatSet

macaroon.Nonce

Machine

MachineEvent

MachineExecRequest

MachineOverviewConfig

MachineVersion

main.getPlacementsRequest

main.getPlacementsResponse

main.memoryResponse

main.reclaimMemoryRequest

main.reclaimMemoryResponse

main.regionResponse

main.regionRow

main.setMemoryLimitRequest

main.statusCode

Type: string

main.TokenAccess

main.tokenInfo

metadataValueResponse

OrganizationRef

OrgMachine

OrgMachinesResponse

OrgVolume

OrgVolumesResponse

OwnershipVerification

placement.RegionPlacement

placement.Weights

Type: map<string, integer>

PostgresAttachedApp

PostgresAttachment

PostgresBackup

PostgresCluster

PostgresClusterEndpoints

PostgresClusterSummary

PostgresDatabase

postgresDatabaseResponse

PostgresEndpoint

PostgresErrorResponse

PostgresExtension

PostgresInstalledExtension

PostgresNodeEndpoints

PostgresUser

PostgresUserCredentials

ProcessStat

resset.Action

Type: integer

restorePostgresClusterRequest

root.VerifiedToken

rotatePostgresPasswordRequest

rotatePostgresPasswordResponse

SecretKey

SecretKeys

SetAppSecretRequest

SetAppSecretResponse

SetSecretkeyRequest

SetSecretkeyResponse

showPostgresClusterResponse

SignalRequest

SignSecretkeyRequest

SignSecretkeyResponse

StopRequest

StrippedLease

UpdateMachineRequest

updateMetadataRequest

updatePostgresUserRoleRequest

UpdateVolumeRequest

upsertMetadataKeyRequest

VerifySecretkeyRequest

Volume

VolumeSnapshot

WaitMachineResponse