Built-in License Fields

Built-in fields are reserved field names. The following table describes each built-in license field that you can define for a customer.

note

License fields labeled "KOTS Only" in the table below apply only to Replicated KOTS installations.

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	(KOTS Only) The endpoint that the KOTS Admin Console uses to synchronize license and download updates. This is typically 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) and is set to midnight UTC on the date selected. If a license does not expire, this field is missing. By default, instances with an expired license continue to run. Additionally, instances installed with KOTS that have an expired license do not receive updates. For more information about the default behavior when a license expires, see License Expiration Handling in About Customers.
isAirgapSupported	(KOTS/kURL/Embedded Cluster) If a license supports air gap installations with the Replicated installers (KOTS, kURL, or Embedded Cluster), then this field is set to true. If Replicated installer air gap installations are not supported, this field is missing. When you enable this field for a license, the license.yaml file will have license metadata embedded in it and must be re-downloaded.
isGeoaxisSupported	(kURL Only) 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.
isGitOpsSupported	important KOTS Auto-GitOps is a legacy feature and is not recommended for use. For modern enterprise customers that prefer software deployment processes that use CI/CD pipelines, Replicated recommends the Helm CLI installation method, which is more commonly used in these types of enterprise environments. (KOTS Only) If a license supports the KOTS AutoGitOps workflow in the Admin Console, this field is set to true. If Auto-GitOps is not supported, this field is either false or missing. See KOTS Auto-GitOps Workflow.
isIdentityServiceSupported	(KOTS Only) If a license supports identity-service enablement for the Admin Console, 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.
isKotsInstallEnabled	If a license supports installation with KOTS, this field is set to true. If KOTS installations are not supported, this field is either false or missing. Note: This field requires that the vendor has the KOTS entitlement.
isSemverRequired	(KOTS Only) 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	(KOTS Only) 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	(KOTS Only) 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 Managing License Type.
signature	The base64 encoded license signature. This value will change when license is updated.
isHelmAirgapEnabled	If a license supports Helm air gap installations, then this field is set to true or missing. If Helm air gap is not supported, this field is missing. When you enable this feature, the license.yaml file will have license metadata embedded in it and must be re-downloaded. This field requires that the "Install Types" feature is enabled for your Vendor Portal team. Reach out to your Replicated account representative to get access.
isHelmInstallEnabled	If a license supports Helm installations, then this field is set to true or missing. If Helm installations are not supported, this field is set to false. This field requires that the vendor only packages the application as Helm charts and Replicated Custom Resources. This field requires that the "Install Types" feature is enabled for your Vendor Portal team. Reach out to your Replicated account representative to get access.
isKurlInstallEnabled	If a license supports installation with kURL, this field is set to true or missing. If kURL installations are not supported, this field is false. This field requires that the vendor has the kURL entitlement and a promoted kURL installer spec. This field also requires that the "Install Types" feature is enabled for your Vendor Portal team. Reach out to your Replicated account representative to get access.
isEmbeddedClusterDownloadEnabled	If a license supports installation with Embedded Cluster, this field is set to true or missing. If Embedded Cluster installations are not supported, this field is false. This field requires that the vendor has the Embedded Cluster entitlement and that the release at the head of the channel includes an Embedded Cluster Config custom resource. This field also requires that the "Install Types" feature is enabled for your Vendor Portal team. Reach out to your Replicated account representative to get access.