Getting the most recent available release, why the 'key' parameter?

Web API
#1

I need to get the most recent available release for my product. I understand I need to use this API call:

https://api.cryptlex.com/v3/docs#tag/Releases/operation/GetUpdateRelease

The endpoint takes a ‘key’ parameter that needs to be a valid license key.

Why is this parameter required? Why can’t I just ask for the most recent release for a

  • Product
  • Channel

without needing to specify a license key?

If I have, for example, 100 devices running a specific version of a (product, channel), I’d like to just make one request to get their most recent release info, not 100 requests, one per device (and license key).

Is there an alternative I could use?

#2

Dear Miguel,

Thank you for your question.

The reason that the key parameter is required when calling the Check for an update endpoint is to ensure that only authorized users can access the release and helps confirm that the requester is allowed to access that particular release.

You may explore the CheckReleaseUpdate() function in LexActivator which is designed to streamline the update check process. When invoked, it automatically triggers a release update callback that indicates whether an update is available and allowed for that license. It also returns a release object containing all relevant details such as release notes, download URL, and other metadata. You can find more details and implementation guidance here: Using LexActivator for release distribution.

Note: CheckReleaseUpdate() always checks for the latest release published for the product provided that the license key is not restricted by Maintenance policy or MaxAllowedReleaseVersion.

If I have, for example, 100 devices running a specific version of a (product, channel), I’d like to just make one request to get their most recent release info, not 100 requests, one per device (and license key).

Could you please provide some additional clarification? It is a bit unclear at the moment.

#3

Hi, thanks for the response!

In our SW we are not using LexActivator. This is a server-side application (REST API) that talks to the Cryptlex API.

So from this server we want to check for updates of a specific product, platform, channel, etc. This way our server could notify all N connected clients that may be running an outdated version to upgrade. Not needing to issue N Cryptlex API calls, one for each connected client.

Hope this makes it clearer, what are our options then?

Thanks

#4

Hi Miguel,

Thank you for clarifying.

Your server can make a GET request to the following endpoint to fetch the latest release information: https://api.cryptlex.com/v3/releases/latest.

Once retrieved, your server can then distribute the relevant update details to all connected clients as needed.

#5

Your server can make a GET request to the following endpoint to fetch the latest release information: https://api.cryptlex.com/v3/releases/latest.

Well, that is precisely what we want to do: call that endpoint from our server. BUT the endpoint requires a license key, and our server is not aware of any. What are our options?

Thanks

#6

Hi,

You can create a dummy license key and use that from your server to check for latest release updates.

For any additional assistance, please feel free to reach out to our support channel at support@cryptlex.com.

#7

Yes, I was considering doing that, thanks for confirming!

1 Like