Create a license.

post https://api.replicated.com/vendor/v1/license

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

app_id

string

required

App Id that this license will be associated with.

assignee

string

required

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

assisted_setup_enabled

boolean

deprecated

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 formatted 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*

license_type

string

required

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

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

Language


xxxxxxxxxx
10
1
curl --request POST \
2
     --url https://api.replicated.com/vendor/v1/license \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "airgap_download_enabled": true,
8
  "require_activation": true
9
}
10
'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201CreateLicenseResponse contains the created license

400Returned on bad input

403Returned if the caller does not have the needed permission

404Returned on resource not found