> This page is for Beam.

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://mediakind.ferndocs.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://mediakind.ferndocs.com/_mcp/server.

# Restore device backup

POST https://app.mk.io/api/v1/projects/{project_name}/fleet/devices/{name}/restore
Content-Type: application/json

Restores a backup to a specific device.

RBAC Capability Required: `fleet.device.update`

Reference: https://mediakind.ferndocs.com/beam/api/fleets/devices/restore-device-backup

## Authentication

- `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer <token>`, where token is your auth token.

## Request

### Path parameters

- `project_name` (string, required)
- `name` (string, required)

### Body (application/json)

This endpoint expects a DeviceRestoreBody.

- `metadata` (DefaultMetadata, required) — Resource metadata.
- `spec` (DeviceRestoreBodySpec, required) — Device restore specification

## Response

### 202

The device backup was successfully restored.

## Errors

### 400 Bad Request Error

Bad Request

- `error` (ErrorDetail, required) — Pertinent information about the error
- `ref` (string, required) — A reference to the request that caused the error.
- `status` (integer, required) — The HTTP status code

### 401 Unauthorized Error

Unauthorized

- `error` (ErrorDetail, required) — Pertinent information about the error
- `ref` (string, required) — A reference to the request that caused the error.
- `status` (integer, required) — The HTTP status code

### 403 Forbidden Error

Forbidden

- `error` (ErrorDetail, required) — Pertinent information about the error
- `ref` (string, required) — A reference to the request that caused the error.
- `status` (integer, required) — The HTTP status code

### 404 Not Found Error

Not Found

- `error` (ErrorDetail, required) — Pertinent information about the error
- `ref` (string, required) — A reference to the request that caused the error.
- `status` (integer, required) — The HTTP status code

### 409 Conflict Error

Conflict

- `error` (ErrorDetail, required) — Pertinent information about the error
- `ref` (string, required) — A reference to the request that caused the error.
- `status` (integer, required) — The HTTP status code

### 429 Too Many Requests Error

Too Many Requests

- `error` (ErrorDetail, required) — Pertinent information about the error
- `ref` (string, required) — A reference to the request that caused the error.
- `status` (integer, required) — The HTTP status code

### 500 Internal Server Error

Internal Server Error

- `error` (ErrorDetail, required) — Pertinent information about the error
- `ref` (string, required) — A reference to the request that caused the error.
- `status` (integer, required) — The HTTP status code

## Types

### DefaultMetadata

- `displayName` (string, required) — A human-readable name for the resource.
- `labels` (map from string to string, optional) — A dictionary of labels associated with the resource. Maximum number of labels: 32. Maximum length of a label or value: 256 characters. Label: alphanumeric, hyphens and underscores. Value: alphanumeric, hyphens, underscores and spaces.

### DeviceRestoreBodySpec

- `restoreFilePath` (string, required) — The relative path to the backup file to restore to the device.
- `restoreAssetFile` (boolean, optional, default: false) — If the asset file should be restored or not, assuming the backup contains the asset file

### ErrorDetail

- `code` (string, required) — The error code.
- `detail` (string, required) — The error message.
- `extraDetail` (map from string to any, optional) — Extra information regarding this error.

## Examples

**Request**

```json
{
  "metadata": {
    "displayName": "string"
  },
  "spec": {
    "restoreFilePath": "<device_name>/<backup_id>/<backup_name>.tar.gz"
  }
}
```

**Response**

```json
{}
```

**SDK Code**

```python
import requests

url = "https://app.mk.io/api/v1/projects/project_name/fleet/devices/name/restore"

payload = {
    "metadata": { "displayName": "string" },
    "spec": { "restoreFilePath": "<device_name>/<backup_id>/<backup_name>.tar.gz" }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://app.mk.io/api/v1/projects/project_name/fleet/devices/name/restore';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"metadata":{"displayName":"string"},"spec":{"restoreFilePath":"<device_name>/<backup_id>/<backup_name>.tar.gz"}}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.mk.io/api/v1/projects/project_name/fleet/devices/name/restore"

	payload := strings.NewReader("{\n  \"metadata\": {\n    \"displayName\": \"string\"\n  },\n  \"spec\": {\n    \"restoreFilePath\": \"<device_name>/<backup_id>/<backup_name>.tar.gz\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://app.mk.io/api/v1/projects/project_name/fleet/devices/name/restore")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"metadata\": {\n    \"displayName\": \"string\"\n  },\n  \"spec\": {\n    \"restoreFilePath\": \"<device_name>/<backup_id>/<backup_name>.tar.gz\"\n  }\n}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://app.mk.io/api/v1/projects/project_name/fleet/devices/name/restore")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"metadata\": {\n    \"displayName\": \"string\"\n  },\n  \"spec\": {\n    \"restoreFilePath\": \"<device_name>/<backup_id>/<backup_name>.tar.gz\"\n  }\n}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://app.mk.io/api/v1/projects/project_name/fleet/devices/name/restore', [
  'body' => '{
  "metadata": {
    "displayName": "string"
  },
  "spec": {
    "restoreFilePath": "<device_name>/<backup_id>/<backup_name>.tar.gz"
  }
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://app.mk.io/api/v1/projects/project_name/fleet/devices/name/restore");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"metadata\": {\n    \"displayName\": \"string\"\n  },\n  \"spec\": {\n    \"restoreFilePath\": \"<device_name>/<backup_id>/<backup_name>.tar.gz\"\n  }\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [
  "metadata": ["displayName": "string"],
  "spec": ["restoreFilePath": "<device_name>/<backup_id>/<backup_name>.tar.gz"]
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://app.mk.io/api/v1/projects/project_name/fleet/devices/name/restore")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```