v1
latestOpenAPI 3.0.02026-07-26258182277.4 KBProvision an instant device
Headers
An optional fields mask
Request body
If true, ensures the provisioned device supports port bonding. If false, ensures no bonding support.
Contents of iPXE script if not supplying URL
URL to download custom iPXE script if not supplying script in entirety
Bypass the validation of the custom iPXE script contained in the URL and download the script regardless.
For users with reserved devices. The unique ID of the target device to provision.
A FQDN for the device. For example: example.hivelocity.net
The unique ID of an Ignition File for FlatcarOS provisions.
A facility code. For example NYC1.
The name of the Operating System to provision on this device. Must match name of an operating system product option.
hourly|monthly|quarterly|semi-annually|annually|biennial|triennial
The unique ID of the desired product to provision.
A Cloud-Init script or a post-install script (Bash for Linux or Powershell for Windows).
User specified values.
Example request
{
"period": "hourly",
"tags": []
}Response
Success
If device was deployed with as an application, this is the name of the application used.
Contents of custom iPXE used to provision device
URL of custom iPXE script used to provision device
The unique ID of the device.
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.
A facility code. For example NYC1.
The unique ID of the order for this device.
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.
This device's service's billing period.
ON|OFF
The first assigned public IP for accessing this device.
The unique ID of the product associated with this device.
The name of the product associated with this device.
The post-install/cloud-init script used during this device's last provisioning.
The unique ID of the service associated with this device.
User specified values.
Example response
{
"period": "hourly"
}