machines

Branch a machine many times.

Creates several live copy-on-write clones of a running machine in one call. Requires the machine:create scope.

post/v1/machines/{id}/branches/batch

Request

Base URL
https://api.smolmachines.com
Auth
HTTP bearer
TypeScript
https://skmtc.dev/smolmachines/apis/smolfleet-api/docs/v1/machines/:id/branches/batch/post.ts
A function with typed inputs. Its response is checked against the schema.

idstring required

Branchable source machine id

branchableboolean

Let every child become another branch source.

countinteger

Number of children to branch (1..=MAX_FORK_BATCH). Ignored when names is non-empty.

freezeSourceboolean

Keep the source paused as a reusable branch base, as for a single branch.

labelsobject nullable

Labels for every child. Omitted = copy the source's labels.

namePrefixstring nullable

Prefix for auto-named children when count is used. Defaults to the source's name.

namesstring[]

Explicit child names. When non-empty, its length is the batch size and count is ignored; otherwise children are auto-named {name_prefix}-{n}.

Children created