Skip to content

Update Machines API OpenAPI spec and models page. #2572

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kcmartin merged 1 commit into from
Oct 15, 2026
Merged

Update Machines API OpenAPI spec and models page. #2572

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions api/machines/models.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,11 @@
description: Schema reference for every object in the Fly Machines API.
---

{/*
This file is generated by scripts/generate-machines-models.py in
superfly/nomad-firecracker from api/machines/openapi.json. Don't edit it
here: changes are overwritten when the Machines API spec changes.
*/}

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

Expand Down Expand Up @@ -460,7 +465,7 @@
| `env_from` | `fly.EnvFrom[]` | No | EnvFrom can be provided to set environment variables from machine fields. |
| `exec` | `string[]` | No | Image Config overrides - these fields are used to override the image configuration. If not provided, the image configuration will be used. ExecOverride is used to override the default command of the image. |
| `files` | `fly.File[]` | No | Files are files that will be written to the container file system. |
| `healthchecks` | `fly.ContainerHealthcheck[]` | No | Healthchecks determine the health of your containers. Healthchecks can use HTTP, TCP or an Exec command. |

Check failure on line 468 in api/machines/models.mdx

View workflow job for this annotation

GitHub Actions / Vale linter 

[vale] reported by reviewdog 🐶
Avoid using 'Healthchecks'.

Raw Output:
{"message":"Avoid using 'Healthchecks'.","location":{"path":"api/machines/models.mdx","range":{"start":{"line":468,"column":110},"end":{"line":468,"column":122}}},"severity":"ERROR","code":{"value":"Vale.Avoid"}}

Check failure on line 468 in api/machines/models.mdx

View workflow job for this annotation

GitHub Actions / Vale linter 

[vale] reported by reviewdog 🐶
Avoid using 'Healthchecks'.

Raw Output:
{"message":"Avoid using 'Healthchecks'.","location":{"path":"api/machines/models.mdx","range":{"start":{"line":468,"column":56},"end":{"line":468,"column":68}}},"severity":"ERROR","code":{"value":"Vale.Avoid"}}
| `image` | `string` | No | Image is the docker image to run. |
| `name` | `string` | No | Name is used to identify the container in the machine. |
| `restart` | `fly.MachineRestart` | No | Restart is used to define the restart policy for the container. |
Expand Down Expand Up @@ -490,7 +495,7 @@
| `grace_period` | `integer` | No | The time in seconds to wait after a container starts before checking its health. |
| `http` | `fly.HTTPHealthcheck` | No | |
| `interval` | `integer` | No | The time in seconds between executing the defined check. |
| `kind` | `fly.ContainerHealthcheckKind` | No | Kind of healthcheck (readiness, liveness) |

Check warning on line 498 in api/machines/models.mdx

View workflow job for this annotation

GitHub Actions / Vale linter 

[vale] reported by reviewdog 🐶
Consider using 'health check' instead of 'healthcheck'.

Raw Output:
{"message":"Consider using 'health check' instead of 'healthcheck'.","location":{"path":"api/machines/models.mdx","range":{"start":{"line":498,"column":58},"end":{"line":498,"column":69}}},"severity":"INFO","code":{"value":"Fly.WordList"}}
| `name` | `string` | No | The name of the check. Must be unique within the container. |
| `success_threshold` | `integer` | No | The number of times the check must succeeed before considering the container healthy. |
| `tcp` | `fly.TCPHealthcheck` | No | |
Expand Down Expand Up @@ -1058,7 +1063,7 @@
| `created_at` | `string` | No | |
| `events` | `MachineEvent[]` | No | |
| `host_features` | `string[]` | No | |
| `host_status` | `string` | No | Enum: ok, unknown, unreachable |

Check warning on line 1066 in api/machines/models.mdx

View workflow job for this annotation

GitHub Actions / Vale linter 

[vale] reported by reviewdog 🐶
Consider using 'OK' or 'okay' instead of 'ok'.

Raw Output:
{"message":"Consider using 'OK' or 'okay' instead of 'ok'.","location":{"path":"api/machines/models.mdx","range":{"start":{"line":1066,"column":41},"end":{"line":1066,"column":43}}},"severity":"INFO","code":{"value":"Fly.WordList"}}
| `id` | `string` | No | |
| `image_ref` | `ImageRef` | No | |
| `incomplete_config` | `fly.MachineConfig` | No | |
Expand Down Expand Up @@ -1184,13 +1189,13 @@
| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `action` | `resset.Action` | No | Action is the action being taken on the specified resource. This is the combination of individual action characters (e.g "rw") - r: read - w: write - c: create - d: delete - C: control |
| `app_feature` | `string` | No | AppFeature is a named set of functionality associated with the app. If this is specified, the AppName field must be set. - images: images in the fly.io registry |

Check warning on line 1192 in api/machines/models.mdx

View workflow job for this annotation

GitHub Actions / Vale linter 

[vale] reported by reviewdog 🐶
Consider using 'capability' or 'feature' instead of 'functionality'.

Raw Output:
{"message":"Consider using 'capability' or 'feature' instead of 'functionality'.","location":{"path":"api/machines/models.mdx","range":{"start":{"line":1192,"column":64},"end":{"line":1192,"column":77}}},"severity":"INFO","code":{"value":"Fly.WordList"}}
| `app_name` | `string` | No | AppName is the name of the app being accessed. |
| `command` | `string[]` | No | Command is the command being executed on a machine. If this is specified, the Machine must be set. |
| `machine_feature` | `string` | No | MachineFeature is a named set of functionality associated with the machine. If this is specified, the Machine field must be set. - metadata: machine metadata service - oidc: OIDC tokens - kmstoken: Petsem tokens for KMS access |

Check warning on line 1195 in api/machines/models.mdx

View workflow job for this annotation

GitHub Actions / Vale linter 

[vale] reported by reviewdog 🐶
Consider using 'capability' or 'feature' instead of 'functionality'.

Raw Output:
{"message":"Consider using 'capability' or 'feature' instead of 'functionality'.","location":{"path":"api/machines/models.mdx","range":{"start":{"line":1195,"column":72},"end":{"line":1195,"column":85}}},"severity":"INFO","code":{"value":"Fly.WordList"}}
| `machine_id` | `string` | No | MachineID is the ID of the machine being accessed (e.g. 7811701f564258). |
| `mutation` | `string` | No | Mutation is the GraphQL mutation being performed. |
| `org_feature` | `string` | No | OrgFeature is a named set of functionality associated with the organization. If this is specified, the OrgSlug field must be set. - wg: WireGuard peers - builder: remote builders - addon: addons - membership: organization membership - billing: billing - litefs-cloud: LiteFS Cloud - authentication: authentication settings |

Check warning on line 1198 in api/machines/models.mdx

View workflow job for this annotation

GitHub Actions / Vale linter 

[vale] reported by reviewdog 🐶
Consider using 'capability' or 'feature' instead of 'functionality'.

Raw Output:
{"message":"Consider using 'capability' or 'feature' instead of 'functionality'.","location":{"path":"api/machines/models.mdx","range":{"start":{"line":1198,"column":64},"end":{"line":1198,"column":77}}},"severity":"INFO","code":{"value":"Fly.WordList"}}
| `org_slug` | `string` | No | OrgSlug is the slug of the organization being accessed. |
| `source_machine` | `string` | No | SourceMachine is the machine ID of the actor attempting access. |
| `storage_object` | `string` | No | StorageObject is the storage object being accessed. If this is specified, the OrgSlug must be set. |
Expand Down Expand Up @@ -1264,7 +1269,7 @@
| `encrypted` | `boolean` | No | |
| `fstype` | `string` | No | |
| `host_features` | `string[]` | No | |
| `host_status` | `string` | No | Enum: ok, unknown, unreachable |

Check warning on line 1272 in api/machines/models.mdx

View workflow job for this annotation

GitHub Actions / Vale linter 

[vale] reported by reviewdog 🐶
Consider using 'OK' or 'okay' instead of 'ok'.

Raw Output:
{"message":"Consider using 'OK' or 'okay' instead of 'ok'.","location":{"path":"api/machines/models.mdx","range":{"start":{"line":1272,"column":41},"end":{"line":1272,"column":43}}},"severity":"INFO","code":{"value":"Fly.WordList"}}
| `id` | `string` | No | |
| `name` | `string` | No | |
| `region` | `string` | No | |
Expand Down Expand Up @@ -1681,7 +1686,7 @@
| `encrypted` | `boolean` | No | |
| `fstype` | `string` | No | |
| `host_features` | `string[]` | No | |
| `host_status` | `string` | No | Enum: ok, unknown, unreachable |

Check warning on line 1689 in api/machines/models.mdx

View workflow job for this annotation

GitHub Actions / Vale linter 

[vale] reported by reviewdog 🐶
Consider using 'OK' or 'okay' instead of 'ok'.

Raw Output:
{"message":"Consider using 'OK' or 'okay' instead of 'ok'.","location":{"path":"api/machines/models.mdx","range":{"start":{"line":1689,"column":41},"end":{"line":1689,"column":43}}},"severity":"INFO","code":{"value":"Fly.WordList"}}
| `id` | `string` | No | |
| `name` | `string` | No | |
| `region` | `string` | No | |
Expand Down
Loading