Baremetal

Deploy Baremetal

post/baremetal/deploy/{project_id}

Deploy a baremetal server to a project.

Authorization

Authorization*string

Bearer YOUR_API_TOKEN with an API token. The X-API-Key: YOUR_API_TOKEN header works too.

Path parameters

project_id*integer

Range1 ≤ value

Request body

application/jsonRequired

model_name*string

Server model name

location_name*string

Location name

hostname*string

Server hostname

label?string | null

Custom label for the server

user?string

SSH username (default: root)

Default"root"

password*string

SSH password

ssh_key_ids?array<integer> | null

List of SSH key IDs (optional)

os_name?string | null

Operating system to install (optional)

disk_layout_name?string | null

Disk layout configuration (optional)

network_id?integer | null

ID of the private network to attach the server to (optional)

addons?array<AddonSelection> | null

Billing addons to add to the server, charged with the first month. See available_addons of each model in GET /baremetal/models.

Rangeitems ≤ 20

Properties (2)

slug*string

Addon slug

Range1 ≤ length ≤ 64

quantity?integer

Units (1 for flat addons)

Range1 ≤ value ≤ 100000Default1

Responses

Successful Response

application/json

BaremetalDeployResponse | BaremetalDeploy3DSResponse

One of

BaremetalDeployResponse

Returned when the upfront charge (setup fee plus first month) succeeded.

Properties (10)

detail*string

hostname*string

model*string

location*string

setup_fee*number

monthly_price*number

addons_monthly?number

Default0

addons_setup?number

Default0

total_charged?number | null

currency?string

Default"USD"

BaremetalDeploy3DSResponse

Returned when Stripe asks for 3D Secure authentication before charging.

Properties (5)

detail*string

requires_action*boolean

client_secret?string | null

payment_intent_id*string

next_action?BaremetalDeployNextAction | null

Properties (2)

type*string

redirect_to_url?string | null