Skip to content

Get update control map

Deprecated
GET
/api/devices/v2/deployments/device/deployments/{deployment_id}/update_control_map
curl --request GET \
--url https://example.com/api/devices/v2/deployments/device/deployments/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/update_control_map \
--header 'Authorization: Bearer <token>'

Return the active update control map for a deployment, or null.

Delegates to :func:app.services.control_map.build_control_map which reads the latest non-expired row from control_map_actions. Returns {"update_control_map": null} when no active action exists so the device agent continues the update unimpeded.

deployment_id
required
Deployment Id
string format: uuid

Successful Response

Media type application/json
Example generated
example

Validation Error

Media type application/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Example generated
{
"detail": [
{
"ctx": {},
"input": "example",
"loc": [
"example"
],
"msg": "example",
"type": "example"
}
]
}