REreplicated
instances

Archive an instance.

Changed on

Deactivate a customer instance, making it inactive and unavailable for future use. Only development, airgap, or inactive instances can be archived.

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

put/instance/{instance_id}/archive

Request

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

Path parameters

instance_idstring required

Instance identifier

Query parameters

cluster_idstring

Optional cluster identifier to disambiguate instance_id

Response

ArchiveCustomerInstanceResponse contains the response to archive an instance

errorstring

Changes