---
title: "Restore interface"
method: POST
path: "/restore_secondary"
tags: ["Restore"]
---

# Restore interface

`POST /restore_secondary`

Submit a request to restore the data from backup

## Headers

- `request_id` string

## Request body

- BackuppbRestoreSecondaryRequest
  - `async` boolean — async or not
  - `backup_name` string — backup name to restore
  - `path` string — if bucket_name and path is set. will override bucket/path in config.
  - `requestId` string — uuid of request, will generate one if not set
  - `sourceClusterID` string — cdc source cluster id
  - `targetClusterID` string — cdc target cluster id

## Response `200`

OK

- BackuppbRestoreBackupResponse
  - `code` 0 | 1 | 2 | 3 | 400 | 404
  - `data` BackuppbRestoreBackupTaskResponse
    - `collection_restore_tasks` BackuppbRestoreCollectionTaskResponse[]
      - `end_time` integer
      - `errorMessage` string
      - `id` string
      - `progress` integer
      - `start_time` integer
      - `state_code` 0 | 1 | 2 | 3 | 4
      - `target_collection_name` string
      - `target_db_name` string
    - `end_time` integer
    - `errorMessage` string
    - `id` string
    - `progress` integer
    - `start_time` integer
    - `state_code` 0 | 1 | 2 | 3 | 4
  - `msg` string — error msg if fail
  - `requestId` string — uuid of the request to response

---

[API](https://skmtc.net/zilliztech/apis/milvus-backup-service.md) · [All operations](https://skmtc.net/zilliztech/apis/milvus-backup-service/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/zilliztech/milvus-backup-service/revisions/f9b1b1989810/schema)