Get the details of a specific update group.

Published on Mar 20, 2026

Prev Next

Get

/v{version}/UpdateGroups/{id}

Security

API Key: api_key

Header parameter nameX-ApiKey

Api Key

API Key: session_id

Header parameter nameX-Session-Id

Session Id

Path parameters

integer (int32) Required

The update group ID.

version

stringRequired

The requested API version

Default"1.20"

Responses

200

Expand All

object

Detailed model of an update group including update and addon information

AddonUpdates

Array of object (V1.Models.UpdateGroupDetailsAddonUpdate)

List of addon update information for the update group detail

object

Update information for the addon update group with update metadata fields

Architecture

string

Target architecture of the update

ForceVersion

boolean

Indicates whether to force the version for the addon update

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

Name

string

Display name of the update

PackageGuid

string (uuid)

Optional package GUID associated with the update

Example00000000-0000-0000-0000-000000000000

PackageType

string

Package type of the update

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

Platform

string

Target platform of the update

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

SemanticVersion

string

Semantic version of the update

Architecture

string

Target architecture of the update group detail

Created

string (date-time)

Creation date in UTC

Edition

object (V1.Models.UpdateGroupDetailsEdition)

Edition details within the update group detailed view

Code

string (uuid)

Unique code for the edition detail

Example00000000-0000-0000-0000-000000000000

integer (int32)

Unique identifier of the edition detail

Name

string

Display name of the edition detail

integer (int32)

Unique identifier of the update group detail

Modified

string (date-time)

Modification date in UTC

Name

string

Display name of the update group detail

Platform

string

Target platform of the update group detail

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

PlayerUpdate

object (V1.Models.UpdateGroupDetailsPlayerUpdate)

Update information for the player update group with update metadata fields

Architecture

string

Target architecture of the update

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

Name

string

Display name of the update

PackageGuid

string (uuid)

Optional package GUID associated with the update

Example00000000-0000-0000-0000-000000000000

PackageType

string

Package type of the update

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

Platform

string

Target platform of the update

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

PlayerUpdateType

string

Type of player update

Valid values[ "Default", "Migration" ]

SemanticVersion

string

Semantic version of the update

PlayerUpdateType

string

Type of player update associated with the update group

Valid values[ "Default", "Migration" ]

ScriptUpdates

Array of object (V1.Models.UpdateGroupDetailsScriptUpdate)

List of script update information for the update group detail

object

Update information for the script update group with update metadata fields

Architecture

string

Target architecture of the update

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

Name

string

Display name of the update

PackageGuid

string (uuid)

Optional package GUID associated with the update

Example00000000-0000-0000-0000-000000000000

PackageType

string

Package type of the update

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

Platform

string

Target platform of the update

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

SemanticVersion

string

Semantic version of the update

400

Bad request

Expand All

object

ValidationErrors

object

property*

Array of string additionalProperties

string

403

Access denied

Expand All

object

string

Message

string

Type

string

Values

object

property*

object additionalProperties

404

Not found

Expand All

object

string

Message

string

Type

string

Values

object

property*

object additionalProperties

500

Unexpected error

Expand All

object

string

Message

string

Type

string

Values

object

property*

object additionalProperties