---
title: "Archive a test plan"
method: POST
path: "/api/plans/{planId}/archive"
tags: ["Test Plans"]
---

# Archive a test plan

`POST /api/plans/{planId}/archive`

## Request

- Base URL: `https://aximo.autify.com`
- URL: `https://aximo.autify.com/api/plans/{planId}/archive`
- Auth: API key in header `x-api-key`
- TypeScript: <https://skmtc.dev/autify/apis/aximo-api/docs/api/plans/:planId/archive/post.ts> (a function with typed inputs; its response is checked against the schema)

Archives (soft-deletes) a test plan. The plan is hidden from plan lists
and can no longer be updated or run, but its member cases, run history,
and schedule are all kept, and the plan stays readable by id with
`archivedAt` set. The schedule is left exactly as configured; the
scheduler skips archived plans, so restoring one resumes its normal
cadence. Idempotent: archiving an already-archived plan succeeds.

## Path parameters

- `planId` string, uuid, required

## Response `200`

Plan archived.

- object
  - `archived` boolean, required

## Other responses

- `400`: Invalid plan ID.
- `401`: Missing or invalid API key.
- `404`: Test plan not found.
- `429`: Rate limit exceeded — e.g. the daily session limit was reached for the organization, or too many API requests were sent in a short window (retry after the number of seconds in the `Retry-After` header).
- `500`: Unexpected server error.

---

[API](https://skmtc.dev/autify/apis/aximo-api.md) - [All operations](https://skmtc.dev/autify/apis/aximo-api/llms.txt) - [OpenAPI document](https://skmtc.dev/autify/apis/aximo-api/revisions/590722011284?raw)