Deployment

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

put/deploy/{deploymentId}

Request

  • Base URL
    https://core.hivelocity.net/api/v2
  • URL
    https://core.hivelocity.net/api/v2/deploy/{deploymentId}
  • Auth
    API key in header X-API-KEY

Headers

X-Fieldsstring mask

An optional fields mask

Request body

additionalNotesstring[]
billingPeriodstring

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

customIPXEScriptContentsstring

Contents of iPXE script if not supplying URL

customIPXEScriptURLstring

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

forceDeviceIdsinteger[]

Either deploy these Device IDs or fail

hostnamesstring[] required
ignitionIdsinteger[]

Specify Ignition file ID for CoreOS/Flatcar provisions

locationCodestring
operatingSystemstring required

Operating System's Name or ID

optionsinteger[]
productIdinteger required
publicSshKeyIdinteger

ID of SSH Key to use for deployment

quantityinteger

Example request

{
  "forceDeviceIds": [],
  "ignitionIds": []
}

Response

Server configuration added to Deployment

deploymentConfigurationobject[]
deploymentIdinteger
deploymentNamestring
emptyboolean
orderNumberstring
pricenumber
startedProvisioningboolean

Changes

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