About Built-in License Fields
This topic describes the built-in license fields. For information about creating custom license fields for a customer, see Managing Custom License Fields.
Built-in License Fields
All applications that are packaged and delivered through the Replicated vendor portal include built-in license fields. Built-in fields are reserved field names and are available in every customer license.
The following table describes each built-in license field that you can define for a customer.
| License field | Description |
|---|---|
appSlug | Application slug value. This value never changes. |
channelID | Current channel ID from which releases will be downloaded. When channel changes, the latest release of that will be downloaded on the next update check. |
channelName | Current channel name from which releases will be downloaded. When channel changes, the latest release of that will be downloaded on the next update check. |
customerName | The name of the customer. |
endpoint | The endpoint that the Replicated admin console uses to sync license and download updates. This is usually https://replicated.app. |
entitlements | The entitlements property includes the expires_at field and any custom entitlements for the license. For more information about adding custom license fields, see Managing Custom License Fields. |
expires_at | Defines the expiration date for the license. The date is encoded in ISO 8601 format (2026-01-23T00:00:00Z). If a license does not expire, this field is missing. By default, an application with an expired license continues to run, but is prevented from receiving updates. To change the behavior of your application when a license expires, you can can add custom logic based on the values for the expires_at field. |
isAirgapSupported | If a license supports air gapped installations, then this field is set to true. If air gapped is not supported, this field is missing. When you enable this feature, the .rli file will have license meta data embedded in it, and must be re-downloaded. |
isGeoaxisSupported | If a license supports integration with GeoAxis, this field is set to true. If GeoAxis is not supported, this field is either false or missing. Note: This field requires that the vendor has the GeoAxis entitlement. It also requires that the vendor has access to the Identity Service entitlement. See Enabling and Configuring Identity Service (Beta). |
isGitOpsSupported | If a license supports gitops-enablement in the admin console, this field is set to true. If GitOps is not supported, this field is either false or missing. |
isIdentityServiceSupported | If a license supports identity-service enablement, this field is set to true. If identity service is not supported, this field is either false or missing. Note: This field requires that the vendor have access to the Identity Service entitlement. |
isSemverRequired | If set to true, this field requires that the admin console orders releases according to Semantic Versioning. This field is controlled at the channel level. For more information about enabling Semantic Versioning on a channel, see Semantic Versioning in About Releases. |
isSnapshotSupported | If a license supports the snapshots backup and restore feature, this field is set to true. If a license does not support snapshots, this field is either missing or false. Note: This field requires that the vendor have access to the Snapshots entitlement. |
isSupportBundleUploadSupported | If a license supports uploading a support bundle in the admin console, this field is set to true. If a license does not support uploading a support bundle, this field is either missing or false. |
licenseID, licenseId | ID of the installed license. This value never changes. |
licenseSequence | Every time a license is updated, its sequence number is incremented. This value represents the license sequence that the client currently has. |
licenseType | This field contains a string value that describes the type of the license. This is currently one of paid, trial, dev or community. For more information about license types, see About Customer License Types. |
signature | The base64 encoded license signature. This value will change when license is updated. |