Sign in

v1

latestOpenAPI 3.0.02026-07-14169306521.0 KB
customers

Patch a customer.

Apply partial updates to a customer's details, license, channels, and entitlements. Only the fields provided in the request body will be updated.

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

patch/customer/{customer_id}

Path parameters

customer_idstring required

Customer identifier

Request body

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_security_center_enabledboolean
is_snapshot_supportedboolean
is_support_bundle_upload_enabledboolean
namestring

Name of the customer that is to be updated.

remove_channelsstring[]

Channels this customer will be removed from.

remove_entitlementsstring[]

List of entitlement names to remove from the customer. Default values will be used.

remove_expires_atboolean
typestring

Response

GetCustomerResponse represents a customer.