Check for an update

Checks whether a new release is available by comparing with the provided release version.

GET/v3/releases/update

Parameters

NameTypeInDescription
platform*stringqueryRelease platform
productId*stringqueryUnique identifier for the product.
accountId*stringqueryUnique identifier for the account.
channelstringqueryRelease channel
version*stringqueryCurrent release version
key*stringqueryLicense key
allowedbooleanqueryOnly get allowed release for the license key.

Responses

200 OK
{
  "id": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "name": "string",
  "channel": "string",
  "version": "string",
  "platforms": [
    "string"
  ],
  "notes": "string",
  "totalFiles": 0,
  "publishedAt": "2019-08-24T14:15:22Z",
  "files": [
    {
      "id": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "name": "string",
      "url": "string",
      "size": 0,
      "downloads": 0,
      "extension": "string",
      "checksum": "string",
      "secured": true,
      "published": true,
      "releaseId": "string",
      "releaseName": "string"
    }
  ],
  "published": true,
  "private": true,
  "archived": true,
  "productId": "string",
  "tenantId": "string"
}