Metadata

Get OTA information for a specific binary type with a given version on some channel. When a named channel has no OTA config for that version, the version is ignored and the channel's config is returned. Returns empty list if no updates are found or channel/application with the given version does not exist in CVS.

Changed on
get/v2/ota-version/{binaryType}

Request

  • Base URL
    https://clientsettings.roblox.com
  • URL
    https://clientsettings.roblox.com/v2/ota-version/{binaryType}
  • Auth
    • none
    • or API key in cookie .ROBLOSECURITY

Path parameters

binaryTypestring required

Binary type of the application to get info for

Query parameters

channelstring

Channel name. If not provided, production is assumed.

versionstring

Application version. Optional when a named channel is set. Required for production.

tagstring

Tag to filter results by. Only applicable to non-studio application types.

namestring

Name to filter results by. Only applicable to non-studio application types.

Response

OK

namestring required

Ota library/plugin name

versionstring required

Version number of asset

downloadUrlstring required

URL to download the ota asset

isStandaloneboolean

Refers to whether the plugin is core to Studio functions, and is used to determine when it is loaded.

assetIdstring

The asset ID of the LuaApp OTA.

assetVersionstring

The asset version of the LuaApp OTA.

maxAppVersionstring

The maximum application version compatible with the LuaApp OTA.

tryoutNamestring

The name of the tryout for the LuaApp OTA.

localAssetURIstring

The local asset URI for the LuaApp OTA.

isForcedUpdateboolean

Indicates whether the LuaApp OTA is a forced update.

appStorageResetIdstring

The application storage reset ID for the LuaApp OTA.

isDevelopmentConfigboolean

Indicates whether the LuaApp OTA is a development configuration.

assetsManifestobject

Inlined assets manifest for the LuaApp OTA.

versionV2integer

VersionV2 of the OTA asset.

Changes

    • info

      the response property / became required for the status (media type: application/json)

    • info

      the response property / became required for the status (media type: text/json)

    • info

      the response property / became required for the status (media type: application/json)

    • info

      the response property / became required for the status (media type: text/json)

    • info

      the response property / became required for the status (media type: application/json)

    • info

      the response property / became required for the status (media type: text/json)

    • info

      added the non-success response with the status