Skip to main content
New to Corsair? See API access, authentication, and error handling.

Apps

create

apps.create Create an app in an organization. The app costs nothing until it has Machines or volumes. Risk: write
Input Output

delete

apps.delete Permanently delete an app with its Machines, volumes, secrets, certificates and IP addresses Risk: destructive · Irreversible
Input Output

get

apps.get Get an app by name Risk: read
Input Output

list

apps.list List the apps in an organization. Pass limit to page through results with next_cursor. Risk: read
Input Output

Certificates

check

certificates.check Look up a hostname’s DNS now and re-validate its certificate Risk: write
Input Output

delete

certificates.delete Remove a hostname and all its certificates from an app Risk: destructive · Irreversible
Input Output

get

certificates.get Get a certificate with the DNS records to create and its validation state Risk: read
Input Output

list

certificates.list List an app’s custom-domain certificates Risk: read
Input Output

request

certificates.request Add a hostname to an app and request Fly-issued (ACME) certificates for it. Fly bills certificates beyond the free allowance. Risk: destructive
Input Output

Ip Assignments

create

ipAssignments.create Assign an IP address to an app. Dedicated IPv4 and egress addresses are billed monthly; shared_v4, v6 and private_v6 are free. Risk: destructive
Input Output

delete

ipAssignments.delete Release an IP address from an app. A released address cannot be got back. Risk: destructive · Irreversible
Input Output

list

ipAssignments.list List an app’s IP addresses, including its shared IPv4 and egress addresses Risk: read
Input Output

Machines

cordon

machines.cordon Cordon a Machine so Fly Proxy stops routing requests to it Risk: write
Input Output

create

machines.create Create (and by default start) a Machine. Fly bills it while it runs and for its root filesystem. Risk: destructive
Input
Output

createLease

machines.createLease Take (or, with lease_nonce, refresh) an exclusive lease on a Machine Risk: write
Input Output

delete

machines.delete Permanently destroy a Machine. It must be stopped unless force is true. Risk: destructive · Irreversible
Input Output

deleteMetadataKey

machines.deleteMetadataKey Delete one metadata key from a Machine Risk: destructive · Irreversible
Input Output

exec

machines.exec Run a command inside a running Machine and return its stdout, stderr and exit code Risk: destructive
Input Output

get

machines.get Get a Machine Risk: read
Input Output

getLease

machines.getLease Get the lease currently held on a Machine Risk: read
Input Output

getMetadata

machines.getMetadata Get a Machine’s metadata key/value pairs Risk: read
Input Output: Record<string, string>

getMetadataKey

machines.getMetadataKey Get one metadata value of a Machine Risk: read
Input Output

list

machines.list List an app’s Machines (all of them; use listForOrg to page through an organization) Risk: read
Input Output: object[]

listEvents

machines.listEvents List a Machine’s recent events, newest first Risk: read
Input Output: object[]

listForOrg

machines.listForOrg List the Machines of every app in an organization, page by page with next_cursor. Pass region: on 2026-11-16 Fly answered 400 “misfired replay” without it whenever the org had a Machine. Risk: read
Input Output

listProcesses

machines.listProcesses List the processes running on a started Machine Risk: read
Input Output: object[]

listVersions

machines.listVersions List a Machine’s configuration versions Risk: read
Input Output: object[]

releaseLease

machines.releaseLease Release a lease you hold on a Machine Risk: write
Input Output

restart

machines.restart Restart a Machine Risk: write
Input Output

setMetadataKey

machines.setMetadataKey Set one metadata key on a Machine Risk: write
Input Output

signal

machines.signal Send a Unix signal to a Machine’s main process Risk: write
Input Output

start

machines.start Start a stopped or suspended Machine. Fly bills CPU and memory while it runs. Risk: destructive
Input Output

stop

machines.stop Stop a Machine, optionally with a signal and timeout Risk: write
Input Output

suspend

machines.suspend Suspend a Machine so the next start can resume it from a memory snapshot Risk: write
Input Output

uncordon

machines.uncordon Uncordon a Machine so Fly Proxy routes requests to it again Risk: write
Input Output

update

machines.update Replace a Machine’s whole configuration (image, size, services…). A larger size bills more. Risk: destructive
Input
Output

updateMetadata

machines.updateMetadata Set several metadata keys at once; an empty string removes a key. Keys not listed stay as they are. Risk: write
Input Output

wait

machines.wait Wait (up to 60 seconds) for a Machine to reach a state, such as started or stopped Risk: read
Input Output

Platform

regions

platform.regions List Fly regions with their location, capacity and whether they need a paid plan Risk: read
Input: empty object Output

Secrets

delete

secrets.delete Delete one secret. Running Machines keep the old values until they are updated with min_secrets_version set to the returned version. Risk: destructive · Irreversible
Input Output

get

secrets.get Get one secret’s name and digest (not its value) Risk: read
Input Output

list

secrets.list List an app’s secrets: names and digests, never values Risk: read
Input Output

set

secrets.set Create or overwrite one secret. An overwritten value cannot be recovered. Running Machines keep the old values until they are updated with min_secrets_version set to the returned version. Risk: destructive
Input Output

update

secrets.update Set and delete several secrets at once: a string sets one, null deletes it. Running Machines keep the old values until they are updated with min_secrets_version set to the returned version. Risk: destructive
Input Output

Tokens

current

tokens.current Show which organization, apps and Machine the stored token is scoped to Risk: read
Input: empty object Output

Volumes

create

volumes.create Create a volume, empty or restored from a snapshot or another volume. Fly bills it by size. Risk: destructive
Input
Output

createSnapshot

volumes.createSnapshot Take a snapshot of a volume now. Fly bills snapshot storage beyond the free allowance. Risk: destructive
Input Output

delete

volumes.delete Permanently destroy a volume and its data Risk: destructive · Irreversible
Input Output

extend

volumes.extend Grow a volume to a larger size. Volumes cannot shrink, and Fly bills the new size. Risk: destructive
Input Output

get

volumes.get Get a volume Risk: read
Input Output

list

volumes.list List an app’s volumes (all of them; use listForOrg to page through an organization) Risk: read
Input Output: object[]

listForOrg

volumes.listForOrg List the volumes of every app in an organization, page by page with next_cursor Risk: read
Input Output

listSnapshots

volumes.listSnapshots List a volume’s snapshots Risk: read
Input Output: object[]

update

volumes.update Change a volume’s automatic snapshots and their retention. More snapshots kept means more billed snapshot storage. Risk: destructive
Input Output