enterprisePortal

Count an app's customers by the portal the vendor manages them in, and its Enterprise Portal customers by version

Changed on

Required RBAC Policy: kots/app/[:appid]/enterprise-portal/access/read kots/app/[:appid]/license/[:customer_id]/read, per customer counted

get/app/{app_id}/enterprise-portal/customer-distribution

Request

  • Base URL
    https://api.replicated.com/vendor/v3
  • URL
    https://api.replicated.com/vendor/v3/app/{app_id}/enterprise-portal/customer-distribution
  • Auth
    API key in header Authorization

Path parameters

app_idstring required

App identifier

Response

GetEnterprisePortalCustomerDistributionResponse counts the app's customers by the portal the vendor manages them in, splits the Enterprise Portal ones by the portal they are routed to, and reports whether the New Portal is set up.

classicinteger

Enterprise Portal customers routed to the Classic Portal.

contentRepoConnectedboolean

The app has a linked content repository.

downloadPortalinteger

Customers managed in the Download Portal rather than the Enterprise Portal.

downloadPortalDisabledboolean

The app-wide switch that puts every customer on the Enterprise Portal is on.

newinteger

Enterprise Portal customers routed to the New Portal.

siteArmedboolean

The app has an active New Portal site.

totalinteger

Enterprise Portal customers. Download Portal customers are not counted.

Changes