Preview resolved Player update targets

POST

/api/v1/update-deployments/preview

curl --request POST \
  --url https://example.com/api/v1/update-deployments/preview \
  --header 'Content-Type: application/json' \
  --cookie tilecast_session=<tilecast_session> \
  --data '{ "releaseId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "screenIds": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ], "groupIds": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ] }'

Requires Owner or Administrator, write scope, and CSRF. Reads a snapshot without writes or commands. Creation repeats the same target expansion and compatibility checks. Offline screens receive a queued command. Other families appear as incompatible in preview and remain excluded from creation. Already-current screens do not receive an update.

Authorizations

• sessionCookie
• userBearer

Parameters

Header Parameters

X-CSRF-Token

string

Cookie-backed browser requests only, and only on unsafe methods. Bearer grants never send it.

Request Body^required

Media typeapplication/json

object

releaseId

required

string format: uuid

screenIds

required

Array<string>

groupIds

required

Array<string>

Example^generated

{
  "releaseId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "screenIds": [
    "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
  ],
  "groupIds": [
    "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
  ]
}

Responses

200

Advisory target preview

Media typeapplication/json

object

data

required

object

targetCount

required

integer

eligibleCount

required

integer

alreadyCurrentCount

required

integer

offlineCount

required

integer

blockedCount

required

integer

screens

required

Array<object>

object

screenId

required

string format: uuid

screenName

required

string

currentVersionCode

required

integer | null format: int64

playerFamily

required

string

playerArchitecture

required

string

recentlyContacted

required

boolean

outcome

required

string

Allowed values: eligible already_current offline incompatible

reason

required

string | null

Example

{
  "data": {
    "screens": [
      {
        "outcome": "eligible"
      }
    ]
  }
}

403

Targets outside the caller’s screen scope

422

Invalid selection or unverified release