Get targeted verified Player update metadata

GET

/api/v1/player/updates/{releaseId}

const url = 'https://example.com/api/v1/player/updates/example';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/api/v1/player/updates/example

Requires an authenticated player credential.

Parameters

Path Parameters

releaseId

required

string

Responses

200

Update metadata

application/json

object

data

object

releaseId

required

string format: uuid

artifactId

The artifact’s asset name.

string

platform

required

string

versionCode

required

integer

versionName

required

string

playerFamily

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

Tilecast Edge and Windows Player only.

Allowed values: x86_64 aarch64

artifactSizeBytes

Every family but Android.

integer

artifactSha256

Every family but Android.

string

/^[a-f0-9]{64}$/

artifactPath

/api/v1/player/updates/{releaseId}/artifact for every family but Android.

string

signedManifest

Tilecast Edge and Windows Player only: the exact bytes of the signed update envelope, base64. The screen verifies the signature and every field against this answer and its install_player_update command before it downloads.

string format: byte

manifestSignature

Tilecast Edge and Windows Player only. The envelope’s base64 Ed25519 signature text.

string

stateSchemaVersion

Tilecast Edge only. The state database schema the release migrates to.

integer

applicationId

Android only.

string

minimumSdk

Android only.

integer

apkSizeBytes

Android only.

integer

apkSha256

Android only.

string

signingCertificateSha256

Android only.

string

apkPath

Android only.

string

Example

{
  "data": {
    "architecture": "x86_64"
  }
}

404

Not targeted