Skip to content

Update Machines API OpenAPI spec and models page. #2599

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
NullHypothesis merged 1 commit into from
Oct 23, 2026
Merged

Update Machines API OpenAPI spec and models page. #2599

Show file tree
Hide file tree
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
8 changes: 4 additions & 4 deletions api/machines/models.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -223,11 +223,11 @@ These are the data models used across the Machines API requests and responses, g

| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `enable_subdomains` | `boolean` | No | |
| `enable_subdomains` | `boolean` | No | Request a wildcard TLS certificate for *.svc.<app-name>.fly.dev. Defaults to false. Certificate provisioning is asynchronous; this does not create services or configure their routing. |
| `idempotency_key` | `string` | No | When set, makes a retry of this exact request safe: a second create with the same key and the same name (or no name) returns the app the first request created, instead of erroring on a false name conflict or creating a duplicate. A second create with the same key but a *different* name is rejected outright; it won't silently hand back the first app. |
| `name` | `string` | No | |
| `network` | `string` | No | |
| `org_slug` | `string` | No | |
| `name` | `string` | No | Globally unique name for the app. Required. |
| `network` | `string` | No | Name of the organization's private network to attach the app to. Creates the network if it does not exist. Omit, use an empty string, or use "default" to select the organization's default network. |
| `org_slug` | `string` | No | Slug of the organization that will own the app, or "personal" for your personal organization. Required. |

## CreateAppResponse

Expand Down
12 changes: 8 additions & 4 deletions api/machines/openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6509,20 +6509,24 @@
"type": "object",
"properties": {
"enable_subdomains": {
"type": "boolean"
"type": "boolean",
"description": "Request a wildcard TLS certificate for *.svc.<app-name>.fly.dev. Defaults to false. Certificate provisioning is asynchronous; this does not create services or configure their routing."
},
"idempotency_key": {
"type": "string",
"description": "When set, makes a retry of this exact request safe: a\nsecond create with the same key and the same name (or no name) returns\nthe app the first request created, instead of erroring on a false name\nconflict or creating a duplicate. A second create with the same key\nbut a *different* name is rejected outright; it won't silently\nhand back the first app."
},
"name": {
"type": "string"
"type": "string",
"description": "Globally unique name for the app. Required."
},
"network": {
"type": "string"
"type": "string",
"description": "Name of the organization's private network to attach the app to. Creates the network if it does not exist. Omit, use an empty string, or use \"default\" to select the organization's default network."
},
"org_slug": {
"type": "string"
"type": "string",
"description": "Slug of the organization that will own the app, or \"personal\" for your personal organization. Required."
}
}
},
Expand Down
Loading