Skip to content

RestoresApi.md

Latest commit

 

History

History
96 lines (65 loc) · 3.6 KB

RestoresApi.md

File metadata and controls

96 lines (65 loc) · 3.6 KB
Raw

ionoscloud_dbaas_postgres.RestoresApi

All URIs are relative to https://api.ionos.com/databases/postgresql

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

cluster_restore_post

cluster_restore_post(cluster_id, create_restore_request)

In-place restore of a cluster

Triggers an in-place restore of the given PostgreSQL.

Example

  • Basic Authentication (basicAuth):
  • Api Key Authentication (tokenAuth):
import ionoscloud_dbaas_postgres
from ionoscloud_dbaas_postgres.models.create_restore_request import CreateRestoreRequest
from ionoscloud_dbaas_postgres.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.ionos.com/databases/postgresql
# See configuration.py for a list of all supported configuration parameters.
configuration = ionoscloud_dbaas_postgres.Configuration(
    host = "https://api.ionos.com/databases/postgresql"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = ionoscloud_dbaas_postgres.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: tokenAuth
configuration.api_key['tokenAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['tokenAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with ionoscloud_dbaas_postgres.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ionoscloud_dbaas_postgres.RestoresApi(api_client)
    cluster_id = '498ae72f-411f-11eb-9d07-046c59cc737e' # str | The unique ID of the cluster.
    create_restore_request = ionoscloud_dbaas_postgres.CreateRestoreRequest() # CreateRestoreRequest | The restore request to create.

    try:
        # In-place restore of a cluster
        api_instance.cluster_restore_post(cluster_id, create_restore_request)
    except Exception as e:
        print("Exception when calling RestoresApi->cluster_restore_post: %s\n" % e)

Parameters

Name Type Description Notes
cluster_id str The unique ID of the cluster.
create_restore_request CreateRestoreRequest The restore request to create.

Return type

void (empty response body)

Authorization

basicAuth, tokenAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
202 Successful operation. -
0 Any erroneous status code: 400 (parse error), 401 (auth error), 402 (trial access), 403 (insufficient permissions), 404 (not found), 405 (unsupported HTTP method), 415 (unsupported content type, 422 (validation error), 429 (request rate limit exceeded), 500 (server error), 503 (maintenance) * Content-Type - application/problem+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]