Provision an instant device

post

https://core.hivelocity.net/api/v2/bare-metal-devices/

Body Params

forceCustomIPXEDownload

boolean

Defaults to false

Bypass the validation of the custom iPXE script contained in the URL and download the script regardless.

hostname

string

required

A FQDN for the device. For example: example.hivelocity.net

script

string

A Cloud-Init script or a post-install script (Bash for Linux or Powershell for Windows).

locationName

string

required

A facility code. For example NYC1.

publicSshKeyId

integer

vlanId

integer

osName

string

required

The name of the Operating System to provision on this device. Must match name of an operating system product option.

productId

integer

required

The unique ID of the desired product to provision.

period

string

Defaults to hourly

customIPXEScriptContents

string

Contents of iPXE script if not supplying URL

forceDeviceId

integer

For users with reserved devices. The unique ID of the target device to provision.

customIPXEScriptURL

string

URL to download custom iPXE script if not supplying script in entirety

200Success