Update a customer.

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

Path Params

customer_id

string

required

Customer identifier

Body Params

Update customer parameters.

app_id

string

required

App to which the channel is associated.

channel_id

string

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

custom_id

string

Custom ID that can be used in external systems.

string

Email of the customer that is to be updated

entitlementValues

array of objects

Applies only to the currently selected app

entitlementValues

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_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_snapshot_supported

boolean

is_support_bundle_upload_enabled

boolean

name

string

required

Name of the customer that is to be updated.

type

string

Responses

Response body

object

customer

object

actions

object

activeInstances

object

airgap

boolean

airgapDownloadedAt

date-time

airgapDownloadedChannelId

string

airgapDownloadedChannelSequence

int64

airgapDownloadedReleaseLabel

string

appType

string

channels

array of objects

channels

object

adoptionRate

array of objects

adoptionRate

object

channelId

string

count

int64

percent

double

releaseSequence

int64

semver

string

totalOnChannel

int64

airgapDiffBundlesEnabled

boolean

airgapDockerRegistryFormatEnabled

boolean

appId

string

appName

string

appSlug

string

buildAirgapAutomatically

boolean

channelIcon

string

channelSequence

int64

channelSlug

string

channel_id

string

chartReleases

array of objects

ChartReleases is a map of chart name -> []string of version labels

chartReleases

object

error

string

hasPreflightSpec

boolean

name

string

version

string

weight

int64

created

date-time

currentVersion

string

customHostnameOverrides

object

customers

object

description

string

embeddedClusterInstallCommand

string

enterprisePartnerChannelID

string

existingClusterInstallCommand

string

extraLintRules

array of objects

extraLintRules

object

gitHubRef

object

Has additional fields

hasKurlInstaller

boolean

swager:ignore

string

isArchived

boolean

isDefault

boolean

isHelmOnly

boolean

is_default_for_customer

boolean

latestChannelSequence

int64

name

string

numActiveInstances

int64

numReleases

int32

pinned_channel_sequence

int64

releaseNotes

string

releaseSequence

int64

releases

array of objects

releases

object

airgapBuildError

string

airgapBuildStatus

string

airgapBundleImages

array of strings

airgapBundleImages

channelIcon

string

channelId

string

channelName

string

channelSequence

int64

created

date-time

createdBy

object

customResourceError

string

customResourceWarnings

array of strings

customResourceWarnings

demotedAt

date-time

hasECInstaller

boolean

hasKurlInstaller

boolean

installationTypes

object

isDemoted

boolean

isRequired

boolean

kurlInstallerID

string

lintResult

object

proxyRegistryDomain

string

registrySecret

string

releaseNotes

string

releasedAt

date-time

replicatedRegistryDomain

string

semver

string

sequence

int64

updated

date-time

updatedBy

object

replicatedRegistryDomain

string

semverRequired

boolean

semverWarning

string

targetKotsVersion

string

updated

date-time

createdAt

date-time

createdBy

object

customId

string

downloadPortalUrl

string

entitlements

array of objects

entitlements

object

isDefault

boolean

name

string

value

string

esInstances

array of objects

esInstances

object

downstreamChannelId

string

downstreamChannelName

string

downstreamChannelSequence

int64

installedReleaseLabel

string

instanceId

string

tags

array of objects

tags

object

instanceId

string

key

string

origin

string

value

string

expiresAt

date-time

string

inactiveInstances

object

installationId

string

installationVersion

string

installedReleaseLabel

string

installedReleaseSequence

int64

instances

array of objects

instances

object

active

boolean

appStatus

string

client

string

cloud

string

clusterId

string

createdAt

date-time

embeddedClusterVersion

string

instanceId

string

isAirgap

boolean

isDummyInstance

boolean

isEmbeddedCluster

boolean

isKurl

boolean

k8sVersion

string

kotsVersion

string

kurlNodeCountReady

int64

kurlNodeCountTotal

int64

lastActive

date-time

licenseId

string

replicatedSdkVersion

string

tags

array of objects

tags

object

instanceId

string

key

string

origin

string

value

string

versionHistory

array of objects

versionHistory

object

clusterId

string

downstreamChannelId

string

downstreamReleaseSequence

int64

instanceId

string

intervalLast

date-time

intervalStart

date-time

nativeHelmCount

int32

replHelmCount

int32

versionLabel

string

isArchived

boolean

isDevModeEnabled

boolean

isDisasterRecoverySupported

boolean

isEmbeddedClusterDownloadEnabled

boolean

isEnterprisePortalEnabled

boolean

isGeoaxisSupported

boolean

isGitopsSupported

boolean

isHelmAirgapEnabled

boolean

isHelmInstallEnabled

boolean

isIdentityServiceSupported

boolean

isInstallerSupportEnabled

boolean

isInstancesLimited

boolean

isKotsInstallEnabled

boolean

isKurlInstallEnabled

boolean

isSnapshotSupported

boolean

isSupportBundleUploadEnabled

boolean

lastActive

date-time

lowercaseName

string

Lowercase fields for ES customer sorting

name

string

pinnedChannelSequence

int64

shipInstallStatus

object

teamId

string

type

string

updatedAt

date-time

updatedBy

object

Language

Credentials

Header


xxxxxxxxxx
1
curl --request PUT \
2
     --url https://api.replicated.com/vendor/v3/customer/customer_id \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

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