Skip to main content
POST
Deploy an operating system onto a machine

Authorizations

Authorization
string
header
required

API key authentication. API keys should be passed using the format Bearer API_KEY.

Path Parameters

projectId
string
required
id
string
required

Body

application/json
os
string
required
customSshKeys
string[]
sshKeySource
enum<string>
default:SSH_KEY_SOURCE_UNKNOWN
Available options:
SSH_KEY_SOURCE_UNKNOWN,
SSH_KEY_SOURCE_PROJECT,
SSH_KEY_SOURCE_USER,
SSH_KEY_SOURCE_NONE
startScript
string
userData
string
deprecated

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

Response

A successful response.

The response is of type object.