> For the complete documentation index, see [llms.txt](https://help.dragen.illumina.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.dragen.illumina.com/dragen-v4.6/reference/licensing/cloud_licensing.md). # Legacy DRAGEN Cloud Licensing {% hint style="warning" %} This page describes the **legacy** licensing system for Bring-Your-Own-License (BYOL) cloud runs, which authenticates with an Illumina-issued alphanumeric username and password. Usage is metered in gigabases against a prepaid quota that is separate from your BioInsight Credit balance, on every DRAGEN version including 4.6. New BYOL deployments should use an Illumina BioInsight Platform API key instead. See [BioInsight Platform Licensing](/dragen-v4.6/reference/licensing/api_key_licensing.md). {% endhint %} Credential based authentication is required for users that run DRAGEN on the cloud with the legacy Bring-Your-Own-License (BYOL) model. DRAGEN must have access to the DRAGEN License server at runtime, license.dragen.illumina.com. DRAGEN also authenticates cloud runs with the instance identity document from the cloud provider's instance metadata service. See Instance Identity for [AWS](/dragen-v4.6/reference/dragen-multi-cloud/dragen-on-aws.md#instance-identity) or [Azure](/dragen-v4.6/reference/dragen-multi-cloud/dragen-on-azure.md#instance-identity). To verify connectivity to the license server, you can query the healthcheck endpoint which will return a 200 status code and a small JSON body if successful. ``` curl https://license.dragen.illumina.com/healthcheck/version --header 'Content-Type: application/json' {"version":""} ``` ## Running DRAGEN Cloud BYOL with Credential Licensing BYOL users must provide credentials to DRAGEN at runtime, using one of two options. ### Providing Credentials via License Credentials File The suggested method for specifying your credentials is through a file passed in to DRAGEN at runtime. The file can be pointed to using the option `--lic-credentials ` or an environment variable containing the path to this file, `DRAGEN_LICENSE_CREDENTIALS_FILE`. This method provides a more secure way to pass credentials, which avoids accidental credentials leaks from command line console logs. The License Credentials File should be formatted as follows; ``` credentials-1= credentials-2= ``` {% hint style="warning" %} **Version requirements**: * `--lic-credentials` requires **DRAGEN 4.2 or higher**. * The `DRAGEN_LICENSE_CREDENTIALS_FILE` environment variable requires **DRAGEN 4.5 or higher**. * **DRAGEN 4.5+ only**: An S3 path can be provided to retrieve the file so it does not need to reside on the local instance. See the Networked Streaming portion of the user guide for more information. {% endhint %} {% hint style="warning" %} **Default license server domain by version**: When using the License Credentials file, DRAGEN selects a default domain based on its version: * **DRAGEN 4.4 and above**: `https://license.dragen.illumina.com` * **DRAGEN 4.3 and earlier**: `https://license.edicogenome.com` To override this behavior, add the `credentials-3` option to the credentials file. Do not specify the protocol (i.e. `https`). ``` credentials-3=license.dragen.illumina.com ``` {% endhint %} ### Providing Credentials via Command Line Alternatively, you can simply provide your credentials over the command line using the option `--lic-server `. The license server URL should be formatted as follows; ``` https://:@license.dragen.illumina.com ``` {% hint style="warning" %} DRAGEN 4.6 prints a warning stating that the `--lic-server` option will be deprecated in future versions. Use a License Credentials File with `--lic-credentials` instead, which also keeps your password out of console logs. {% endhint %} ## Retrieving License Information and usage using dragen\_lic There are two options for retrieving information and usage for your licenses using the packaged dragen\_lic tool. Examples for each one are below. {% hint style="warning" %} **Version requirement**: Retrieving license information using the `dragen_lic` tool is only supported on **DRAGEN 4.4 and above**. {% endhint %} * Basic Output (i.e. no additional arguments). This is the recommended method to view license information by a human user as the output is more readable. * JSON Output (i.e. using the -j flag). This is the recommended method to view license information by a machine user as the output is already in a machine readable JSON format. **Note**: Just like running DRAGEN as noted above, you must specify your credentials using the `--lic-credentials` or `--lic-server` command line options. ``` $ dragen_lic --lic-credentials my_credentials.cfg ``` ``` User: DRAGEN Version: Time: