---
title: "Update Deployment Restore Internal"
method: PATCH
path: "/internal/deployment-restores/{restore_id}"
tags: ["internal"]
---

# Update Deployment Restore Internal

`PATCH /internal/deployment-restores/{restore_id}`

## Request

- Base URL: `https://api.mengi.cloud` (the document declares no server; this is the origin it was published from)
- URL: `https://api.mengi.cloud/internal/deployment-restores/{restore_id}`
- Auth: none declared. Required headers: `x-service-token`

Record restore progress reported by the worker (internal).

## Path parameters

- `restore_id` string, uuid, required

## Headers

- `x-service-token` string, required

## Request body

- DeploymentRestoreUpdate: Progress report from the worker (internal API).
  - `status` 'queued' | 'running' | 'completed' | 'failed' | 'rolled_back'
  - `step` string, nullable
  - `progress_message` string, nullable
  - `error_message` string, nullable
  - `safety_backup_name` string, nullable

## Response `200`

Successful Response

- DeploymentRestoreResponse: One restore of a deployment from a backup, with its progress.
  - `id` string, uuid, required
  - `deployment_id` string, uuid, required
  - `backup_name` string, required
  - `safety_backup_name` string, nullable
  - `status` string, required
  - `step` string, nullable
  - `progress_message` string, nullable
  - `error_message` string, nullable
  - `created_at` string, date-time, required
  - `started_at` string, date-time, nullable
  - `completed_at` string, date-time, nullable

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/mengi/apis/mengi-cloud.md) · [All operations](https://skmtc.dev/mengi/apis/mengi-cloud/llms.txt) · [OpenAPI document](https://skmtc.dev/mengi/apis/mengi-cloud/revisions/4ae9b375cdbb?raw)