> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://api.docs.modulards.com/modular-ds-public-api/backups/restorations/retrieve-a-restoration/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://api.docs.modulards.com/_mcp/server.

# Retrieve a restoration

GET https://api.modulards.com/api/public/v1/site-restorations/{siteRestoration}

Returns one restoration: how it is going, or why it failed. It carries the same information as "List restorations".

Restorations are read only: nothing in this API starts, cancels or downloads one. The dashboard does.

Reference: https://api.docs.modulards.com/modular-ds-public-api/backups/restorations/retrieve-a-restoration

## Authentication

- `Authorization` header (bearer token, required) — Personal access token created in the Modular DS dashboard; read-only tokens can only call GET endpoints.

## Request

### Path parameters

- `siteRestoration` (string, required)

### Query parameters

- `include` (string, optional) — Relations to add to the answer, comma separated: `site` (the website) and `backup` (the backup the restoration came from).

## Response

### 200

200 - Site restoration

- `data` (ApiPublicV1SiteRestorationsSiteRestorationGetResponsesContentApplicationJsonSchemaData, optional)
- `jsonapi` (ApiPublicV1SiteRestorationsSiteRestorationGetResponsesContentApplicationJsonSchemaJsonapi, optional)

## Types

### ApiPublicV1SiteRestorationsSiteRestorationGetResponsesContentApplicationJsonSchemaData

- `attributes` (ApiPublicV1SiteRestorationsSiteRestorationGetResponsesContentApplicationJsonSchemaDataAttributes, optional)
- `id` (string, optional)
- `links` (ApiPublicV1SiteRestorationsSiteRestorationGetResponsesContentApplicationJsonSchemaDataLinks, optional)
- `type` (string, optional)

### ApiPublicV1SiteRestorationsSiteRestorationGetResponsesContentApplicationJsonSchemaJsonapi

- `version` (string, optional)

### ApiPublicV1SiteRestorationsSiteRestorationGetResponsesContentApplicationJsonSchemaDataAttributes

- `created_at` (string, optional)
- `created_by` (double, optional)
- `error_message` (any, optional, nullable)
- `expired_at` (string, optional)
- `phase` (enum, optional) — State to read: in_progress, done or failed. One that never finished before expired_at reads failed.
  - Allowed values: `in_progress`, `done`, `failed`, `excluded`
- `site_backup_id` (integer, optional) — Id of the backup that is restored.
- `status` (string, optional) — Raw step of the operation, for example a download, unzip, move or database step.
- `type` (enum, optional) — Kind of operation: restoration, or a migration to the same domain, to a new domain, to an existing website or to a staging website.
  - Allowed values: `restoration`, `migration_same_domain`, `migration_new_domain`, `migration_existing_site`, `migration_staging`
- `updated_at` (string, optional)
- `uri` (any, optional, nullable)

### ApiPublicV1SiteRestorationsSiteRestorationGetResponsesContentApplicationJsonSchemaDataLinks

- `self` (string, optional)

## Examples

**Response**

```json
{
  "data": {
    "attributes": {
      "created_at": "2026-09-14T10:00:00.000000Z",
      "created_by": 34,
      "error_message": null,
      "expired_at": "2026-09-14T12:00:00.000000Z",
      "phase": "done",
      "site_backup_id": 9001,
      "status": "finished",
      "type": "restoration",
      "updated_at": "2026-09-14T10:18:00.000000Z",
      "uri": null
    },
    "id": "501",
    "links": {
      "self": "{{base_url}}/api/public/v1/site-restorations/501"
    },
    "type": "site-restorations"
  },
  "jsonapi": {
    "version": "1.1"
  }
}
```

**SDK Code**

```python 200 - Site restoration
import requests

url = "https://api.modulards.com/api/public/v1/site-restorations/siteRestoration"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript 200 - Site restoration
const url = 'https://api.modulards.com/api/public/v1/site-restorations/siteRestoration';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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

```go 200 - Site restoration
package main

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

func main() {

	url := "https://api.modulards.com/api/public/v1/site-restorations/siteRestoration"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

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

}
```

```ruby 200 - Site restoration
require 'uri'
require 'net/http'

url = URI("https://api.modulards.com/api/public/v1/site-restorations/siteRestoration")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

```java 200 - Site restoration
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.modulards.com/api/public/v1/site-restorations/siteRestoration")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php 200 - Site restoration
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.modulards.com/api/public/v1/site-restorations/siteRestoration', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

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

```csharp 200 - Site restoration
using RestSharp;

var client = new RestClient("https://api.modulards.com/api/public/v1/site-restorations/siteRestoration");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift 200 - Site restoration
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.modulards.com/api/public/v1/site-restorations/siteRestoration")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

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()
```