Bare Metal Devices

Provision an instant device

post/bare-metal-devices/

Request

  • Base URL
    https://core.hivelocity.net/api/v2
  • URL
    https://core.hivelocity.net/api/v2/bare-metal-devices/
  • Auth
    API key in header X-API-KEY

Headers

X-Fieldsstring mask

An optional fields mask

Request body

bondingSupportboolean

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

customIPXEScriptContentsstring

Contents of iPXE script if not supplying URL

customIPXEScriptURLstring

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

forceCustomIPXEDownloadboolean

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

forceDeviceIdinteger

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

hostnamestring required

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

ignitionIdinteger

The unique ID of an Ignition File for FlatcarOS provisions.

locationNamestring required

A facility code. For example NYC1.

osNamestring required

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

periodstring

hourly|monthly|quarterly|semi-annually|annually|biennial|triennial

productIdinteger required

The unique ID of the desired product to provision.

publicSshKeyIdinteger
scriptstring

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

tagsstring[]

User specified values.

vlanIdinteger

Example request

{
  "period": "hourly",
  "tags": []
}

Response

Success

appNamestring

If device was deployed with as an application, this is the name of the application used.

customIPXEScriptContentsstring

Contents of custom iPXE used to provision device

customIPXEScriptURLstring

URL of custom iPXE script used to provision device

deviceIdinteger

The unique ID of the device.

hostnamestring

The user specified hostname for the device. Note: If the hostname is changed in the portal or on the device itself this value may not reflect the actual hostname on the device.

locationNamestring

A facility code. For example NYC1.

orderIdinteger

The unique ID of the order for this device.

osNamestring

The name of the operating system currently installed on this device. Note: If you manually reload your own OS over IPMI this value may not reflect the OS currently on your device.

periodstring

This device's service's billing period.

powerStatusstring

ON|OFF

primaryIpstring

The first assigned public IP for accessing this device.

productIdinteger

The unique ID of the product associated with this device.

productNamestring

The name of the product associated with this device.

publicSshKeyIdinteger
scriptstring

The post-install/cloud-init script used during this device's last provisioning.

serviceIdinteger

The unique ID of the service associated with this device.

tagsstring[]

User specified values.

vlanIdinteger

Example response

{
  "period": "hourly"
}

Changes

No recorded changes to this operation across all 1 revision of this API.