Creating Releases

Whenever you release a new version of your software, create a new release in the Cryptlex admin portal (or through the Web API). After you create the release, upload your software bundle with the release, or host the software bundle on your own server.

Creating a release

To create a release through the admin portal, go to the Releases section in the sidebar and click the Add button. A create release form with the following fields pops up:

Field	Description
Name	A friendly name to identify the release, such as `MyApp v1.2`.
Version	Dot-separated digits in one of three forms: `$MAJOR.$MINOR`, `$MAJOR.$MINOR.$PATCH`, or `$MAJOR.$MINOR.$PATCH.$BUILD` (for example, `1.2`, `1.2.3`, or `1.2.3.4`).
Platforms	Such as `windows`, `macos`, or `linux`, so each operating system gets the right files. You create the platforms you need; none exist by default.
Channel	Such as `stable` or `beta`, so you can ship pre-release versions to a subset of users. Only `stable` exists by default; create any others you need.
Notes	The release notes, which support Markdown.

Uploading release files

In the create release form, upload the release files that you want to distribute securely to your licensed users.

You can also upload a release file using any command-line HTTP client like curl:

curl -X PUT https://releases.cryptlex.com/v3/{RELEASE_ID}/myapp.zip    -H "Authorization: Bearer {ACCESS_TOKEN}"    -T "/path/to/myapp.zip"

For accounts in the EU data region, use releases.eu.cryptlex.com as the hostname.

If you are using self-hosted Cryptlex, upload to your own releases hostname instead:

curl -X PUT https://releases.mycompany.com/v3/{RELEASE_ID}/myapp.zip    -H "Authorization: Bearer {ACCESS_TOKEN}"    -F "file=@/path/to/myapp.zip"

The access token must have at least the following two permissions: release:read, release:write.

The file name in the upload URL must only contain letters, numbers, and the special characters . (period), - (hyphen), and _ (underscore).

Adding an external release file

Instead of uploading release files to Cryptlex, you can add release files hosted on your own server.

To add an external release file, click the Add External File option in the actions menu. Enter the details of your external release file in the form and click the Add File button. After that, the entry appears in the Files column of the table.

Publishing a release

Once all the changes have been finalized, click the Publish button to freeze the release. After a release is published it becomes read-only.

Archiving a release

Archiving a release allows you to hide a published release from end users without deleting it. Archived releases will no longer appear in the customer portal or in SDK update checks.

To archive a release:

Go to the Releases page in the admin portal and locate the release you want to archive.
From the actions menu for that release, click Archive.

Archiving a release is permanent; it cannot be unarchived. However, if customers already know the exact release URL, they can still download it directly.

Once your release is published, see Distributing Releases to deliver it to your customers and Auto-Updates to notify your app when a newer version is available.

Overview Distributing Releases

Last updated: 7/13/2026