---
title: "Archive an instance."
method: PUT
path: "/instance/{instance_id}/archive"
tags: ["instances"]
---

# Archive an instance.

`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`

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

## Path parameters

- `instance_id` string, required

## Query parameters

- `cluster_id` string

## Response `200`

ArchiveCustomerInstanceResponse contains the response to archive an instance

- object
  - `customerInstance` CustomerInstance
    - `active` boolean
    - `appSlug` string
    - `appStatus` string
    - `client` string
    - `cloud` string
    - `clusterId` string
    - `createdAt` string, date-time
    - `embeddedClusterVersion` string
    - `instanceId` string
    - `isAirgap` boolean
    - `isArchived` boolean
    - `isDummyInstance` boolean
    - `isEmbeddedCluster` boolean
    - `isKurl` boolean
    - `k8sVersion` string
    - `kotsVersion` string
    - `kurlNodeCountReady` integer
    - `kurlNodeCountTotal` integer
    - `lastActive` string, date-time
    - `licenseId` string
    - `replicatedSdkVersion` string
    - `securitySummary` InstanceSecuritySummary: InstanceSecuritySummary represents aggregated security information for an instance
      - `fixableVulnerabilityCounts` VulnCounts
        - `critical` integer
        - `high` integer
        - `low` integer
        - `medium` integer
        - `total` integer
      - `fixableVulnerabilityCountsCoverage` VulnCountCoverage: VulnCountCoverage describes how many successfully resolved image summaries contributed to a vulnerability count. It lets consumers distinguish a complete zero from a partial or unavailable fixable-count result.
        - `availableImages` integer
        - `totalImages` integer
      - `imageCount` integer
      - `lastScannedAt` string, date-time
      - `vulnerabilityCounts` VulnCounts
        - `critical` integer
        - `high` integer
        - `low` integer
        - `medium` integer
        - `total` integer
    - `serviceAccountId` string
    - `tags` InstanceTag[]
      - `instanceId` string
      - `key` string
      - `origin` string
      - `value` string
    - `versionHistory` CustomerInstanceVersionHistory[]
      - `clusterId` string
      - `downstreamChannelId` string
      - `downstreamReleaseSequence` integer
      - `instanceId` string
      - `intervalLast` string, date-time
      - `intervalStart` string, date-time
      - `nativeHelmCount` integer
      - `replHelmCount` integer
      - `versionLabel` string
  - `error` string

## Other responses

- `401`: Return if the caller is not authorized
- `403`: Returned if the caller does not have the needed permission
- `404`: Returned on resource not found

## Changes

- **2026-11-03** `a36c6aead22f`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/replicated/apis/vendor-api-v3-2/changes/instance/:instance_id/archive/put.md)

---

[API](https://skmtc.dev/replicated/apis/vendor-api-v3-2.md) - [All operations](https://skmtc.dev/replicated/apis/vendor-api-v3-2/llms.txt) - [OpenAPI document](https://skmtc.dev/replicated/apis/vendor-api-v3-2/revisions/a36c6aead22f?raw)