Sign in

v1

latestOpenAPI 3.0.02026-07-14169306521.0 KB
customers

Update a customer.

Update the details, license, and channel assignments for an existing customer. Supports changing metadata, license type, expiration, entitlements, and feature flags. Parameters that are not provided are reset to default values.

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

put/customer/{customer_id}

Path parameters

customer_idstring required

Customer identifier

Request body

app_idstring required

App to which the channel is associated.

channel_idstring

The channel id to which the customer is associated. This is the default channel for the customer.

custom_idstring

Custom ID that can be used in external systems.

emailstring

Email of the customer that is to be updated

expires_atstring

Format is YYYY-MM-DD, e.g. 2021-02-24

is_airgap_enabledboolean
is_dev_mode_enabledboolean
is_disaster_recovery_supportedboolean
is_embedded_cluster_download_enabledboolean
is_embedded_cluster_multinode_enabledboolean
is_enterprise_portal_enabledboolean
is_geoaxis_supportedboolean
is_gitops_supportedboolean
is_helm_airgap_enabledboolean
is_helm_install_enabledboolean
is_identity_service_supportedboolean
is_kots_install_enabledboolean
is_kurl_install_enabledboolean
is_snapshot_supportedboolean
is_support_bundle_upload_enabledboolean
namestring required

Name of the customer that is to be updated.

typestring

Response

GetCustomerResponse represents a customer.