Skip to content

Report bounded Player update preparation and installer status

POST
/api/v1/player/update-deployments/{deploymentId}/status
Media typeapplication/json
object
state
required

succeeded is accepted only for a Tilecast Edge release: it is the screen’s explicit confirmation that the provisional release passed its health checks, and the only way an Edge target settles. Other families settle from the heartbeat.

Allowed values: downloading downloaded verifying ready waiting_for_permission waiting_for_user installing reconnecting failed succeeded
downloadedBytes
integer
permissionStatus
string
<= 64 characters
installerStatus

Tilecast Edge sends provisional with reconnecting, confirmed with succeeded, and rolled_back with a failed report of a release that was activated and then rolled back.

string
<= 64 characters
error

A bounded reason code, never free text from a server response.

string
<= 240 characters

Status accepted

Deployment cancelled or complete

Invalid status