Update/reload instant device

put

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Updates and reloads an instant device when provided the Device ID, OS name and Hostname.

Path Params

deviceId

integer

required

Query Params

skipPowerCheck

boolean

If true, bypass the powered off check.

Body Params

appName

string

The name of the application to provision on this device. Must match the name field of an application

appUserData

object

User data for specific application if reloading using app option

customIPXEScriptContents

string

Contents of iPXE script if not specifying URL. If both script URL and contents are not specified, the last iPXE script contents are used if OS selection requires an iPXE script.

customIPXEScriptURL

string

URL to download custom iPXE script if not specifying contents in entirety. If both script URL and contents are not specified, the last iPXE script contents are used if OS selection requires an iPXE script.

forceReload

boolean

Defaults to false

Whether to force a reload even if fields have not changed

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.

osName

string

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

publicSshKeyId

integer

script

string

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

tags

Headers

X-Fields

string

An optional fields mask

Responses

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.

404

Device Not Found

Language

Credentials

Header

Loading…

Response

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

application/json

200Device updated.