PricingDedicated ServersVPS
API Reference
Signup

Receive product, quantity and options to be added on the deployment

put
https://core.hivelocity.net/api/v2/deploy/
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required

Id of the deployment to interact with

Body Params
string
forceDeviceIds
array of integers
Defaults to

Either deploy these Device IDs or fail

forceDeviceIds
string

Contents of iPXE script if not supplying URL

integer

ID of SSH Key to use for deployment

ignitionIds
array of integers
Defaults to

Specify Ignition file ID for CoreOS/Flatcar provisions

ignitionIds
integer
Defaults to 1
hostnames
array of strings
required
hostnames*
additionalNotes
array of strings
additionalNotes
string
Defaults to monthly

must be one of ['monthly', 'quarterly', 'semi-annually', 'annually', 'biennial', 'triennial', 'hourly']

string
required

Operating System's Name or ID

options
array of integers
Defaults to
options
integer
required
string

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

Headers
string

An optional fields mask

Responses

400

Your configuration have incompatible or unavailable options

401

Access to this Deployment not Allowed

403

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

404

Deployment Not Found

Updated 2 days ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 2 days ago