CubePathDOCS

Baremetal

Deploy Baremetal

post/baremetal/deploy/{project_id}

Deploy a baremetal server to a project.

Autorización

Authorization
Authorization*string

Bearer YOUR_API_TOKEN con un token de API. También vale la cabecera X-API-Key: YOUR_API_TOKEN.

Parámetros de ruta

project_id*integer
Rango1 ≤ value

Parámetros de cabecera

Idempotency-Key?string | null
Rangolength ≤ 255

Cuerpo de la petición

application/jsonObligatorio
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)

Por defecto"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.

Rangoitems ≤ 20
Propiedades (2)
slug*string

Addon slug

Rango1 ≤ length ≤ 64
quantity?integer

Units (1 for flat addons)

Rango1 ≤ value ≤ 100000Por defecto1
use_balance?boolean

Pay with the account balance instead of (or before) the card. Signed-in users with payment permission only; API tokens always pay by card. The dashboard reads GET /balance spendable_cash.

Por defectofalse
max_balance_usd?number | string | null

Most you accept to be taken from the account balance, in USD. Required with use_balance. If the card part would end up larger than the total minus this amount the request is refused so you can confirm again.

Uno de
number
Rango0 ≤ value
string
Rangopattern ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

Respuestas

Successful Response

application/json

BaremetalDeployResponse | BaremetalDeploy3DSResponse
Uno de
BaremetalDeployResponse

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

Propiedades (14)
detail*string
hostname*string
model*string
location*string
setup_fee*number
monthly_price*number
addons_monthly?number
Por defecto0
addons_setup?number
Por defecto0
total_charged?number | null
currency?string
Por defecto"USD"
payment_method?string | null
balance_charged?number
Por defecto0
card_charged?number
Por defecto0
balance_after?number | null
BaremetalDeploy3DSResponse

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

Propiedades (7)
detail*string
requires_action*boolean
client_secret?string | null
payment_intent_id*string
next_action?BaremetalDeployNextAction | null
Propiedades (2)
type*string
redirect_to_url?string | null
balance_planned?number
Por defecto0
card_amount?number | null