---
search:
  tags:
    - console-backup
    - POST
seo:
  description: >-
    Decrypts the archive with the recovery key, checks… Reference for the POST
    /api/v1/console-backup/restore/check endpoint in the TimescaleDB Enterprise
    API.
  noindex: true
sidebar:
  label: Check a restore archive
  badge: POST
title: Check a restore archive
type: openapi-operation
---
Decrypts the archive with the recovery key, checks each file, applies the version rules, and gives the summary and the differences with this console. It refuses (409) an archive of another console, of a demo or production console of the other kind, or with another TSE_DB_ENCRYPTION_KEY or TSE_MESH_SUBNET: restore such an archive with ./timescale-enterprise.sh --restore. It writes nothing. The console never stores the key.

`POST /api/v1/console-backup/restore/check`

**Request body** (`application/json`, required)

- `name` (string) — The name of the archive on the target
- `recovery_key` (string, required) — The recovery key (AGE-SECRET-KEY-1...). The console keeps it in memory for the restore only; it never stores or logs it
- `target_id` (string) — The target of the archive. Set target\_id and name, or upload\_id
- `upload_id` (string) — The id of an uploaded archive

Request body example:

```json
{
  "name": "string",
  "recovery_key": "string",
  "target_id": "string",
  "upload_id": "string"
}
```

**Responses**

- `200` — OK
- `default` — Error

Response example, 200:

```json
{
  "archive_id": "string",
  "confirm_name": "string",
  "console_name": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "files": 0,
  "key_fingerprint": "string",
  "loaded_packs": [
    "string"
  ],
  "now": {
    "release": "string",
    "servers": 0,
    "services": 0
  },
  "release": "string",
  "running_workflows": [
    {
      "id": "string",
      "operation": "string",
      "started_at": "string",
      "target_name": "string"
    }
  ],
  "servers": 0,
  "services": 0,
  "size": 0,
  "tiers": [
    "string"
  ]
}
```
