Create a KOTS customer.

post

https://api.replicated.com/vendor/v3/customer

Create a new customer and license for a specified app, with options for channel assignment, license type, expiration, and feature flags. The created customer will be available for management and download.

Required RBAC Policy: kots/app/[:appid]/license/create

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Customer create parameters.

app_id

string

required

App to which the customer is associated.

channel_id

string

Channel to which the customer license is associated. This is the default channel for the customer.

custom_id

string

Custom ID that can be used in external systems.

string

Email address of the customer that is to be created

entitlementValues

array of objects

entitlementValues

expires_at

string

is_airgap_enabled

boolean

is_dev_mode_enabled

boolean

is_disaster_recovery_supported

boolean

is_embedded_cluster_download_enabled

boolean

is_embedded_cluster_multinode_enabled

boolean

is_geoaxis_supported

boolean

is_gitops_supported

boolean

is_helm_airgap_enabled

boolean

is_helm_install_enabled

boolean

is_identity_service_supported

boolean

is_installer_support_enabled

boolean

is_kots_install_enabled

boolean

is_kurl_install_enabled

boolean

is_snapshot_supported

boolean

is_support_bundle_upload_enabled

boolean

name

string

required

Name of the customer that is to be created.

saml_allowed

boolean

SAML configuration - vendors can enable/disable SAML for customers Customers configure their IdP details via market-api

type

string

Responses

Language

Credentials

Header

Loading…

Response

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

application/json

201GetCustomerResponse represents a customer.

400Returned on bad input

401Return if the caller is not authorized

403Returned if the caller does not have the needed permission