Get a list of available player software updates

Prev Next
Get
/v{version}/Updates

Results are scoped to the authenticated customer. Only updates with a manifest and a valid edition are returned. When multiple records share the same package GUID and semantic version, the customer-specific record takes precedence over a global one.

Security
API Key: api_key
Header parameter nameX-ApiKey

Api Key

API Key: session_id
Header parameter nameX-Session-Id

Session Id

Path parameters
version
stringRequired

The requested API version

Query parameters
architecture
string

Architecture to filter updates.

editionId
integer (int32)

Edition identifier to filter updates.

platform
string

Platform to filter updates.

Responses
200

OK

Array of object
object

Represents an update package with metadata and versioning information.

Architecture
string

Architecture of the update package.

Created
string (date-time)

Creation date in UTC

Edition
object (V1.Models.UpdateEdition)

Represents edition information for an update

Code
string (uuid)

Unique code identifier for the edition

Id
integer (int32)

Unique identifier of the edition

Name
string

Display name of the edition

Id
integer (int32)

Unique identifier of the update.

MaxPlayerVersion
string

Maximum player version supported by the update.

MinPlayerVersion
string

Minimum player version required for the update.

Modified
string (date-time)

Modification date in UTC

Name
string

Name of the update.

PackageGuid
string (uuid)

Unique identifier for the update package.

PackageType
string

Specifies the type of update package.

Valid values[ "PlayerUpdate", "Addon", "Script" ]
Platform
string

Supported platforms

Valid values[ "Windows", "Linux", "Android", "Tizen" ]
PlayerUpdateType
string

Player update types

Valid values[ "Default", "Migration" ]
SemanticVersion
string

Semantic version of the update.

400

Bad Request

Expand All
object
ValidationErrors
object
property*
Array of string additionalProperties
string
401

Unauthorized

Expand All
object
Id
string
Message
string
Type
string
Values
object
property*
object additionalProperties
403

Access denied

Expand All
object
Id
string
Message
string
Type
string
Values
object
property*
object additionalProperties
500

Unexpected error

Expand All
object
Id
string
Message
string
Type
string
Values
object
property*
object additionalProperties