> For the complete documentation index, see [llms.txt](https://docs.ionos.com/mongodb-sdk-ruby/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.ionos.com/mongodb-sdk-ruby/api/restoresapi.md).

# RestoresApi

All URIs are relative to *<https://api.ionos.com/databases/mongodb>*

| Method                                                | HTTP request                           | Description                   |
| ----------------------------------------------------- | -------------------------------------- | ----------------------------- |
| [**clusters\_restore\_post**](#clusters_restore_post) | **POST** /clusters/{clusterId}/restore | In-place restore of a cluster |

## clusters\_restore\_post

> clusters\_restore\_post(cluster\_id, create\_restore\_request)

In-place restore of a cluster

Triggers an in-place restore of the given MongoDB cluster.

### Examples

```ruby
require 'time'
require 'ionoscloud-dbaas-mongo'
# setup authorization
IonoscloudDbaasMongo.configure do |config|
  # Configure HTTP basic authorization: basicAuth
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'

  # Configure API key authorization: tokenAuth
  config.api_key['Authorization'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = IonoscloudDbaasMongo::RestoresApi.new
cluster_id = 'cluster_id_example' # String | The unique ID of the cluster.
create_restore_request = IonoscloudDbaasMongo::CreateRestoreRequest.new({snapshot_id: 'dcd31531-3ac8-11eb-9feb-046c59cc737e'}) # CreateRestoreRequest | The restore request to create.

begin
  # In-place restore of a cluster
  api_instance.clusters_restore_post(cluster_id, create_restore_request)
rescue IonoscloudDbaasMongo::ApiError => e
  puts "Error when calling RestoresApi->clusters_restore_post: #{e}"
end
```

#### Using the clusters\_restore\_post\_with\_http\_info variant

This returns an Array which contains the response data (`nil` in this case), status code and headers.

> \<Array(nil, Integer, Hash)> clusters\_restore\_post\_with\_http\_info(cluster\_id, create\_restore\_request)

```ruby
begin
  # In-place restore of a cluster
  data, status_code, headers = api_instance.clusters_restore_post_with_http_info(cluster_id, create_restore_request)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => nil
rescue IonoscloudDbaasMongo::ApiError => e
  puts "Error when calling RestoresApi->clusters_restore_post_with_http_info: #{e}"
end
```

### Parameters

| Name                         | Type                                                                         | Description                    | Notes |
| ---------------------------- | ---------------------------------------------------------------------------- | ------------------------------ | ----- |
| **cluster\_id**              | **String**                                                                   | The unique ID of the cluster.  |       |
| **create\_restore\_request** | [**CreateRestoreRequest**](/mongodb-sdk-ruby/models/createrestorerequest.md) | The restore request to create. |       |

### Return type

nil (empty response body)

### Authorization

basicAuth, tokenAuth

### HTTP request headers

* **Content-Type**: application/json
* **Accept**: application/json


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.ionos.com/mongodb-sdk-ruby/api/restoresapi.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.