Patch a customer.

patch

https://api.replicated.com/vendor/v3/customer/{customer_id}

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

customer_id

string

required

Customer identifier

Body Params

Patch customer parameters.

add_channels

array of objects

Channels this customer will be assigned to.

add_channels

add_entitlements

array of objects

List of entitlements to add for the customer.

add_entitlements

custom_id

string

Custom ID that can be used in external systems.

string

Email of the customer that is to be updated

expires_at

string

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

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_enterprise_portal_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_kots_install_enabled

boolean

is_kurl_install_enabled

boolean

is_security_center_enabled

boolean

is_snapshot_supported

boolean

is_support_bundle_upload_enabled

boolean

name

string

Name of the customer that is to be updated.

remove_channels

array of strings

Channels this customer will be removed from.

remove_channels

remove_entitlements

array of strings

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

remove_entitlements

remove_expires_at

boolean

saml_allowed

boolean

SAML configuration - vendors can enable/disable SAML for customers

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

200GetCustomerResponse represents a customer.

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