Sign in

v1

latestOpenAPI 3.0.32026-07-13122146291.9 KB
Machines

Deploy an operating system onto a machine

Deploys an operating system onto a bare-metal machine. All data on the machine will be lost.

post/v1/projects/{projectId}/machines/{id}/deploy

Path parameters

projectIdstring required
idstring required

Request body

customSshKeysstring[]
osstring required
sshKeySource'SSH_KEY_SOURCE_UNKNOWN' | 'SSH_KEY_SOURCE_PROJECT' | 'SSH_KEY_SOURCE_USER' | 'SSH_KEY_SOURCE_NONE'
startScriptstring
userDatastring

DEPRECATED: use startScript to run a script on boot, and sshKeySource or customSshKeys to set authorized ssh keys

Response

A successful response.

object required