Skip to content
Tilecast Docs

List Player update deployments, narrowed to the caller's screen scope

GET
/api/v1/update-deployments
curl --request GET \
  --url https://example.com/api/v1/update-deployments

Requires an authenticated dashboard user.

Responses

Section titled “ Responses ”

200

Section titled “200”

Deployment list

Media typeapplication/json
object
data
required
object
items
required
Array<object>
object
id
required
string format: uuid
name
required
string
mode
required
string
Allowed values: download_only install_now maintenance_window
status
required
string
Allowed values: pending active paused completed cancelled
createdAt
required
string format: date-time
completedAt
string | null format: date-time
platform
required

The Player operating-system platform. The set grows with new players; clients must tolerate values they do not recognize.

string
playerFamily
required

The Player release family. A deployment reaches only screens of its release’s family, and for edge and windows only screens of its architecture. The set grows with new players; clients must tolerate values they do not recognize.

string
architecture
required
string
versionCode
required
integer format: int64
versionName
required
string
targetCount
required
integer
succeededCount
required
integer
failedCount
required
integer
waitingForUserCount
required
integer
rolloutMode
required
string
Allowed values: full canary
incompatibleCount
integer
rolloutPhase
required
string
Allowed values: full canary paused
canarySize
required
integer
<= 50
pauseReason
required
string | null
lastFailure
required
string | null
Example
{
  "data": {
    "items": [
      {
        "mode": "download_only",
        "status": "pending",
        "rolloutMode": "full",
        "rolloutPhase": "full"
      }
    ]
  }
}