Skip to main content
POST
CLI equivalent: ornn launch <reservation-id> --mode vm --key <key-id> (or --mode bare-metal). Add --wait to wait for SSH. Walkthroughs: VM and Bare Metal.

Authorizations

Authorization
string
header
required

Create an organization API key in Account Settings > Developer. Do not send this key to the Kubernetes API server.

Path Parameters

reservation_id
string<uuid>
required

An owned reservation ID (reservationId in reservation responses).

Body

application/json

Send an empty object to use the reservation's defaults.

access_mode
enum<string>

Defaults to the reservation's access mode. Use the mode your reservation was booked with.

Available options:
virtual-machine,
bare-metal
disk_id
string<uuid> | null

VM only. Overrides the reservation's saved disk for VMs this request creates. When omitted, the saved disk is used; a VM launch with no disk available fails with disk_required. Must be omitted for Bare Metal.

network_mode
enum<string>
default:public

public exposes SSH on the host's public address. private connects the machine to your organization's private network.

Available options:
public,
private
network_id
string<uuid> | null

Private networking only. An existing private network in your organization. Omit it to use the organization's shared network. This does not create a network.

node_count
integer | null

How many of the reservation's nodes to provision when launch starts provisioning. Defaults to every reserved node and cannot exceed it. Ignored when the reservation already has machines.

Required range: x >= 1
ssh_key_ids
string<uuid>[]

Active SSH keys in your organization to authorize. The keys are also attached to the reservation. Omit to use the reservation's current keys, or every active organization key when none are selected.

request_id
string | null

Optional client token for this request. Reuse it when you retry the same launch so Ornn can recognize repeated commands.

Response

Provisioning started on the returned nodes.

nodes
object[]
required