Update app license for a given licenseId.

put

https://api.replicated.com/vendor/v1/license/{license_id}

Note: that all fields are required to be passed or they will be overwritten to blank or default values.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

license_id

string

required

License identifier

Body Params

activation_email

string

required

If activation is required this is the email the code will be sent to.

airgap_download_enabled

boolean

required

assignee

string

required

License Label name, ie name of customer who is using license.

assisted_setup_enabled

boolean

required

channel_id

string

required

Channel id that the license will be associated with.

expiration_date

string

required

Date that the license will expire, can be null for no expiration or formated by year-month-day ex. 2016-02-02.

expiration_policy

string

required

Defines expiration policy for this license.

Values: ignore: replicated will take no action on a expired license noupdate-norestart: application updates will not be downloaded, and once the application is stopped, it will not be started again noupdate-stop: application updates will not be downloaded and the application will be stopped

external_support_bundle

boolean

Defines whether this license should use the external support bundle generator.

field_values

array of objects

required

An array of field values for custom fields of a given app

field_values*

is_app_version_locked

boolean

A license can be optionally locked to a specific release

license_type

string

required

LicenseType can be set to "dev", "trial", or "prod"

locked_app_patch_version

int64

If app version is locked, this is the patch version to lock it to (patch_sequence)

locked_app_version

int64

If app version is locked, this is the version to lock it to (sequence)

require_activation

boolean

required

If this license requires activation set to true, make sure to set activation email as well.

update_policy

string

required

If set to automatic will auto update remote license installation with every release. If set to manual will update only when on-premise admin clicks the install update button.

use_console_support_spec

boolean

Defines whether this license should use support bundle specs from console.

Responses

200UpdateLicenseResponse contains the license

400Returned on bad input

401Return if the caller is not authorized

403Returned if the caller does not have the needed permission

404Returned on resource not found