Skip to content
Tilecast Docs

Read the deployment header, release artifact size, and per-screen update state for the screens in the caller's scope

GET
/api/v1/update-deployments/{id}
curl --request GET \
  --url https://example.com/api/v1/update-deployments/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0

Requires an authenticated dashboard user.

Parameters

Section titled “ Parameters ”

Path Parameters

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

Responses

Section titled “ Responses ”

200

Section titled “200”

Deployment detail

Media typeapplication/json
object
data
required
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
required
string | null format: date-time
rolloutMode
required
string
Allowed values: full canary
rolloutPhase
required
string
Allowed values: full canary paused
canarySize
required
integer
<= 50
pauseReason
required
string | null
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
artifactSizeBytes
required
integer format: int64
screens
required
Array<object>

Every property is always present; an unset value is an explicit null.

object
screenId
required
string format: uuid
screenName
required
string
previousVersionCode
required
integer | null format: int64
expectedVersionCode
required
integer format: int64
downloadedBytes
required
integer format: int64
permissionStatus
required
string | null
installerStatus
required
string | null
state
required
string
Allowed values: pending offline incompatible already_current held cancelled downloading downloaded verifying ready waiting_for_permission waiting_for_user installing reconnecting failed succeeded
safeError
required
string | null
updatedAt
required
string format: date-time
isCanary
required
boolean
downloadStartedAt
required
string | null format: date-time
downloadedAt
required
string | null format: date-time
installStartedAt
required
string | null format: date-time
completedAt
required
string | null format: date-time
Example
{
  "data": {
    "mode": "download_only",
    "status": "pending",
    "rolloutMode": "full",
    "rolloutPhase": "full",
    "screens": [
      {
        "state": "pending"
      }
    ]
  }
}

404

Section titled “404”

Scoped callers only - unknown or reaching no screen in scope