---
title: "Receive product, quantity and options to be added on the deployment"
method: PUT
path: "/deploy/{deploymentId}"
tags: ["Deployment"]
---

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

`PUT /deploy/{deploymentId}`

## Headers

- `X-Fields` string, mask

## Request body

- DeploymentCustomization
  - `additionalNotes` string[]
  - `billingPeriod` string — must be one of ['monthly', 'quarterly', 'semi-annually', 'annually', 'biennial', 'triennial', 'hourly']
  - `customIPXEScriptContents` string — Contents of iPXE script if not supplying URL
  - `customIPXEScriptURL` string — URL to download custom iPXE script if not supplying script in entirety
  - `forceDeviceIds` integer[] — Either deploy these Device IDs or fail
  - `hostnames` string[], required
  - `ignitionIds` integer[] — Specify Ignition file ID for CoreOS/Flatcar provisions
  - `locationCode` string
  - `operatingSystem` string, required — Operating System's Name or ID
  - `options` integer[]
  - `productId` integer, required
  - `publicSshKeyId` integer — ID of SSH Key to use for deployment
  - `quantity` integer

## Response `200`

Server configuration added to Deployment

- Deployment
  - `deploymentConfiguration` object[]
  - `deploymentId` integer
  - `deploymentName` string
  - `empty` boolean
  - `orderNumber` string
  - `price` number
  - `startedProvisioning` boolean

## Other 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

---

[API](https://skmtc.net/hivelocity/apis/hivelocity-api.md) · [All operations](https://skmtc.net/hivelocity/apis/hivelocity-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/hivelocity/hivelocity-api/versions/ee6b717b5015/schema)