REreplicated
apps

Update app trial signup settings.

Changed on

Update the trial signup configuration settings for the specified app.

Required RBAC Policy: kots/app/[:appid]/update

put/app/{app_id}/trial-signup-settings

Request

  • Base URL
    https://api.replicated.com/vendor/v3
  • URL
    https://api.replicated.com/vendor/v3/app/{app_id}/trial-signup-settings
  • Auth
    API key in header Authorization

Path parameters

app_idstring required

App identifier

Request body

defaultChannelIdstring required

Default channel ID for trial signups

domainFilterDomainsstring[]

List of domains to block or allow

domainFilterModestring

Domain filter mode: off, block, or allow

domainFilterUseDefaultBlocklistboolean

Whether to include the default consumer domain blocklist

embeddedClusterEnabledboolean required

Whether embedded cluster is enabled

expirationDaysinteger required

Number of days until trial expires (max 90)

helmInstallEnabledboolean required

Whether helm install is enabled

isAirgapEnabledboolean required

Whether Embedded Cluster installer air gap is enabled for trial signups

isEmbeddedClusterMultiNodeEnabledboolean required

Whether multi-node Embedded Cluster is enabled for trial signups

isHelmAirgapEnabledboolean required

Whether helm airgap is enabled

licenseTypestring required

License type: trial or community

supportBundleUploadEnabledboolean required

Whether support bundle upload is enabled

termsAndConditionsUrlstring

Terms and conditions URL (optional, must be HTTPS)

Response

TrialSignupSettingsResponse contains the trial signup settings for an app

Changes

  • a36c6aead22fRevision changes
    • breaking

      added the new required request property

    • breaking

      added the new required request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status