---
title: "Archive or restore a project"
method: POST
path: "/v1/projects/{projectId}/archive"
---

# Archive or restore a project

`POST /v1/projects/{projectId}/archive`

## Request

- Base URL: `https://docs.greatwait.dev` (the document declares no server; this is the origin it was published from)
- URL: `https://docs.greatwait.dev/v1/projects/{projectId}/archive`
- Auth: one of:
  - HTTP bearer
  - HTTP bearer and API key in header `Greatwait-Environment` and API key in header `Greatwait-Project`

Archives or restores the caller's project. Archiving parks the complete project: no new occurrence is dispatched, while schedules, endpoints, keys, grants and retained history remain intact. Restoring clears that project-wide hold without rewriting any schedule; an occurrence whose instant passed while archived becomes due, matching schedule pause and resume. Only organization administrators may make this project-wide change.

## Path parameters

- `projectId` string, required

## Headers

- `If-Match` string, required

## Request body

- object
  - `archived` boolean, required

## Response `200`

Archive or restore a project

- object
  - `createdAt` string, nullable, required
  - `deletionCounts` object, required
    - `endpoints` integer, required
    - `keys` integer, required
    - `runs` integer, required
    - `schedules` integer, required
  - `environmentKinds` string[], required
  - `id` string, required
  - `name` string, required
  - `status` 'active' | 'archived', required
  - `version` integer, required

## Other responses

- `400`: Problem document. Possible codes at this status: invalid_request.
- `401`: Problem document. Possible codes at this status: authentication_required, credential_expired, credential_revoked.
- `403`: Problem document. Possible codes at this status: scope_missing.
- `404`: Problem document. Possible codes at this status: not_found.
- `409`: Problem document. Possible codes at this status: state_conflict, version_conflict.
- `429`: Problem document. Possible codes at this status: rate_limited.
- `503`: Problem document. Possible codes at this status: capability_not_configured, service_unavailable.

---

[API](https://skmtc.dev/greatwait/apis/greatwait-v1.md) · [All operations](https://skmtc.dev/greatwait/apis/greatwait-v1/llms.txt) · [OpenAPI document](https://skmtc.dev/greatwait/apis/greatwait-v1/revisions/6855bce23e72?raw)