Releases

Check for an update

Changed on

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

get/v3/releases/update

Request

  • Base URL
    https://api.cryptlex.com
  • URL
    https://api.cryptlex.com/v3/releases/update
  • Auth
    none required

Query parameters

platformstring required

Release platform

productIdstring required

Unique identifier for the product.

accountIdstring required

Unique identifier for the account.

environmentIdstring uuid

Unique identifier for the environment. Leave unset for the production environment.

channelstring

Release channel

versionstring required

Current release version

keystring required

License key

allowedboolean

Only get allowed release for the license key.

Response

OK

idstring required
createdAtstring date-time required
updatedAtstring date-time required
namestring required
channelstring required
versionstring required
platformsstring[] required
notesstring required
totalFilesinteger required
publishedAtstring date-time nullable
publishedboolean required
privateboolean required
archivedboolean required
productIdstring required
tenantIdstring required

Changes

    • info

      added the new optional query request parameter environmentId

    • breaking

      for the query request parameter key, the minLength was increased from 0 to 1

    • breaking

      for the query request parameter platform, the minLength was increased from 0 to 1

    • breaking

      for the query request parameter productId, the minLength was increased from 0 to 1

    • breaking

      for the query request parameter version, the minLength was increased from 0 to 1

    • breaking

      the response property's minLength was decreased from 1 to 0 for the response status

    • breaking

      the response property's minLength was decreased from 1 to 0 for the response status

    • warning

      removed the optional property from the response with the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      added the required property to the response with the status