Roll back a group of devices to their previous application version

POST

/api/v1/devices/rollback-version

curl --request POST \
  --url http://localhost:3000/api/v1/devices/rollback-version \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <X-API-Key>' \
  --data '{ "deviceSelector": { "matchLabels": { "site": "plant-a" }, "matchExpressions": [ { "key": "line", "operator": "In", "values": [ "line-3" ] } ] }, "reason": "example", "applicationPackageId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }'

• Development
• Production

Re-deploys, in place, the revision (version and parameters) each matching device ran before its current one. Each device follows the rules of the device route: a device of a shared deployment is split off first, and its Margo deployment id is kept. Devices with no earlier revision, or with history written before revisions existed, are reported as skipped rather than failing the batch. This does not abort an in-flight rollout — see the deployment rollback route.

Authorizations

• api-key
• bearer

Parameters

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

deviceSelector

required

Label selector choosing which devices to roll back

object

matchLabels

Exact label equality match; all entries must match (AND).

object

Example

{
  "site": "plant-a"
}

matchExpressions

Array<object>

object

key

required

Label key to match on

string

Example

line

operator

required

string

Allowed values: In NotIn Exists DoesNotExist

Example

In

values

Array<string>

Example

[
  "line-3"
]

reason

Operator-supplied reason, recorded on the audit entry

string

<= 500 characters

applicationPackageId

Which application package to roll back on every matching device.

string format: uuid

Responses

200

Rollback evaluated for every matching device

400

DeviceSelector missing or malformed

403

Forbidden — caller lacks required permission

404

No devices matched the selector