---
search:
  tags:
    - console-backup
    - POST
seo:
  description: >-
    Checks the archive as the check does, and needs the name of… Reference for
    the POST /api/v1/console-backup/restore endpoint in the TimescaleDB
    Enterprise API.
  noindex: true
sidebar:
  label: Start a console restore
  badge: POST
title: Start a console restore
type: openapi-operation
---
Checks the archive as the check does, and needs the name of this console. Refused (409) while a workflow or a console backup runs. From the start, the console refuses new workflows, enrollments and console backups. It backs up its current state (Core and Logs) to the directory pre-restore of the local backup directory, stages the archive, and restarts its container. After the restart, every user logs in again. Poll get-console-restore for the state.

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

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

- `confirm_name` (string, required) — The name of this console (confirm\_name of the check)
- `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
{
  "confirm_name": "string",
  "name": "string",
  "recovery_key": "string",
  "target_id": "string",
  "upload_id": "string"
}
```

**Responses**

- `202` — Accepted
- `default` — Error

Response example, 202:

```json
{
  "archive_created_at": "2019-08-24T14:15:22Z",
  "archive_id": "string",
  "archive_name": "string",
  "error": "string",
  "pre_restore_backup": "string",
  "started_at": "2019-08-24T14:15:22Z",
  "started_by": "string",
  "state": "idle",
  "step": "string"
}
```
