DocumentationSupport
API Reference
Log In

Export customer instances for an app as CSV or JSON.

get
https://api.replicated.com/vendor/v3/app//customer_instances

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)

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

App identifier

Query Params
string

Sort column

boolean

Sort descending

string

Format to export: csv or json

customerIds
array of strings

Comma separated array of customer ids

customerIds
boolean
string

Customer-level filters

boolean
boolean
boolean
string
string
string
boolean

Instance-level filters

Responses

Updated 5 days ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
*/*
application/json

Updated 5 days ago