REreplicated
apps

Update a license field for a given appId and licenseFieldName.

Changed on

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

put/app/{app_id}/license-field/{license_field_name}

Request

  • Base URL
    https://api.replicated.com/vendor/v3
  • URL
    https://api.replicated.com/vendor/v3/app/{app_id}/license-field/{license_field_name}
  • Auth
    API key in header Authorization

Path parameters

app_idstring required

App identifier

license_field_namestring required

Field name

Request body

defaultstring required

Optional default value for this licensefield.

enumOptionsstring[]

Enum options for the entitlement field (only for Enum type).

hiddenboolean required

Indicates if this field will be visible from the on-premise license screen.

requiredboolean required

Indicates if this field will be required from the on-premise license screen.

titlestring required

Title of custom license field to display.

Response

EditLicenseFieldResponse contains the license fields

defaultstring
enumOptionsstring[]
hiddenboolean
namestring
requiredboolean
titlestring
typestring

Changes

  • a36c6aead22fRevision changes
    • info

      added the new optional request property

    • info

      added the optional property to the response with the status