REreplicated
apps

Export customer instances for an app as CSV or JSON.

Changed on

Generate and return a report of all customer instances for a specific app, in either CSV or JSON format. Includes instance metadata and supports filtering by customer IDs and archived status.

Required RBAC Policy: kots/app/[:appid]/read (app-level gate; results are also filtered per-customer by kots/app/[:appid]/license/[:licenseid]/read)

get/app/{app_id}/customer_instances

Request

  • Base URL
    https://api.replicated.com/vendor/v3
  • URL
    https://api.replicated.com/vendor/v3/app/{app_id}/customer_instances
  • Auth
    API key in header Authorization

Path parameters

app_idstring required

App identifier

Query parameters

sortColumnstring

Sort column

sortDescboolean

Sort descending

formatstring

Format to export: csv or json

customerIdsstring[]

Comma separated array of customer ids

querystring

Customer-level filters

activeboolean
inactiveboolean
archivedboolean
licenseTypestring
channelNamestring
adoptionRateFilterstring
includeArchivedboolean

Instance-level filters

Response

ListAppCustomerInstancesResponse contains the list of customers

Changes

  • a36c6aead22fRevision changes
    • warning

      deleted the query request parameter IncludeArchived

    • info

      added the new optional query request parameter active

    • info

      added the new optional query request parameter adoptionRateFilter

    • info

      added the new optional query request parameter archived

    • info

      added the new optional query request parameter channelName

    • info

      added the new optional query request parameter inactive

    • info

      added the new optional query request parameter includeArchived

    • info

      added the new optional query request parameter licenseType

    • info

      added the new optional query request parameter query