Comment on page

RestoresApi

RestoresApi
All URIs are relative to https://api.ionos.com/databases/postgresql
Method
HTTP request
Description
​clusterRestorePost​
POST /clusters/{clusterId}/restore
In-place restore of a cluster
clusterRestorePost
clusterRestorePost(clusterId, createRestoreRequest)
In-place restore of a cluster
Triggers an in-place restore of the given PostgreSQL.
Example
// Import classes:
import com.ionoscloud.dbaaspostgres.ApiClient;
import com.ionoscloud.dbaaspostgres.ApiException;
import com.ionoscloud.dbaaspostgres.Configuration;
import com.ionoscloud.dbaaspostgres.auth.*;
import com.ionoscloud.dbaaspostgres.model.*;
import com.ionoscloud.dbaaspostgres.api.RestoresApi;
​
public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    
    // Configure HTTP basic authorization: basicAuth
    HttpBasicAuth basicAuthentication = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
    basicAuthentication.setUsername("YOUR USERNAME");
    basicAuthentication.setPassword("YOUR PASSWORD");
​
​
    RestoresApi apiInstance = new RestoresApi(defaultClient);
    String clusterId = "498ae72f-411f-11eb-9d07-046c59cc737e"; // String | The unique ID of the cluster.
    CreateRestoreRequest createRestoreRequest = new CreateRestoreRequest(); // CreateRestoreRequest | The restore request to create.
    try {
      apiInstance.clusterRestorePost(clusterId, createRestoreRequest);
    } catch (ApiException e) {
      System.err.println("Exception when calling RestoresApi#clusterRestorePost");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}
⚠️ Note: for the example above, you need to provide all parameters to the method call. Null values will resolve to the API defaults.
Parameters
Name
Type
Description
Notes
clusterId
String
The unique ID of the cluster.
​
createRestoreRequest
​CreateRestoreRequest​
The restore request to create.
​
Return type
null (empty response body)
HTTP request headers
Content-Type: application/json
Accept: application/json

Method	HTTP request	Description
clusterRestorePost	POST /clusters/{clusterId}/restore	In-place restore of a cluster

Name	Type	Description	Notes
clusterId	String	The unique ID of the cluster.
createRestoreRequest	CreateRestoreRequest	The restore request to create.

Last modified 4mo ago