Provision an instant device

post

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

bondingSupport

boolean

If true, ensures the provisioned device supports port bonding. If false, ensures no bonding support.

customIPXEScriptContents

string

Contents of iPXE script if not supplying URL

customIPXEScriptURL

string

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

forceCustomIPXEDownload

boolean

Defaults to false

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

forceDeviceId

integer

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

hostname

string

required

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

ignitionId

integer

The unique ID of an Ignition File for FlatcarOS provisions.

locationName

string

required

A facility code. For example NYC1.

osName

string

required

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

period

string

Defaults to hourly

productId

integer

required

The unique ID of the desired product to provision.

publicSshKeyId

integer

script

string

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

tags

vlanId

integer

Headers

X-Fields

string

An optional fields mask

Responses

201

Device provisioning started

400

Invalid device parameters.

403

You have not been granted permission to complete this action. Please contact your account manager to grant the proper permission.

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success