Update a deployment on one device

PUT

/api/v1/deployments/{id}/devices/{deviceId}

curl --request PUT \
  --url http://localhost:3000/api/v1/deployments/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/devices/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <X-API-Key>' \
  --data '{ "name": "example", "parameterOverrides": {}, "targetNamespace": "example", "desiredState": "PENDING", "metadata": {} }'

• Development
• Production

Splits the device off its deployment (unless it is the only target) and applies the change to it alone. Returns the deployment that now holds the device.

Authorizations

• api-key
• bearer

Parameters

Path Parameters

id

required

string format: uuid

Deployment UUID

deviceId

required

string format: uuid

Device UUID

Header Parameters

x-organization-id

string format: uuid

UUID of the organization (tenant) the request acts in. It selects the tenant and grants nothing: the server checks membership or an open tenant switch. Not needed for global operations. A malformed value returns 400. API keys are fixed to their own organization; another organization returns 403. The x-organization-source header grants nothing.

Request Body^required

Media typeapplication/json

object

name

string

parameterOverrides

object

key

additional properties

any

targetNamespace

Null clears the override

string

nullable

desiredState

string

Allowed values: PENDING INSTALLING INSTALLED FAILED REMOVING REMOVED

metadata

object

key

additional properties

any

Responses

200

Deployment updated on the device

400

Invalid body or the device is not a target

403

Forbidden — caller lacks required permission

404

Deployment not found