Skip to content
Tilecast Docs

Report bounded Player update preparation and installer status

POST
/api/v1/player/update-deployments/{deploymentId}/status
curl --request POST \
  --url https://example.com/api/v1/player/update-deployments/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/status \
  --header 'Content-Type: application/json' \
  --data '{ "state": "downloading", "downloadedBytes": 1, "permissionStatus": "example", "installerStatus": "example", "error": "example" }'

Requires an authenticated player credential.

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters”
deploymentId
required
string format: uuid

Request Bodyrequired

Section titled “Request Bodyrequired”
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

Responses

Section titled “ Responses ”

200

Section titled “200”

Status accepted

Media typeapplication/json
object
data
required
object
state
required
string
Allowed values: downloading downloaded verifying ready waiting_for_permission waiting_for_user installing reconnecting failed succeeded
Example
{
  "data": {
    "state": "downloading"
  }
}

409

Section titled “409”

Deployment cancelled or complete

422

Section titled “422”

Invalid status, or succeeded for a release that is not Tilecast Edge