REreplicated
instances

Batch archive customer instances.

Changed on

Archives multiple customer instances in a single request. Only development, airgap, or inactive instances are eligible. Instances that cannot be archived (e.g., active production instances or instances the caller lacks permission for) are skipped and returned in the skipped array with a reason.

Required RBAC Policy: kots/app/[:appid]/license/[:licenseid]/update

post/app/{app_id}/instances/archive

Request

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

Path parameters

app_idstring required

App identifier

Request body

Response

BatchArchiveCustomerInstancesResponse contains the bulk archive response.

archivedinteger
errorstring
totalinteger

Changes