ionoscloud-dbaas-postgres 3.0.0

IONOS DBaaS PostgreSQL REST API

ionoscloud-dbaas-postgres

An enterprise-grade Database is provided as a Service (DBaaS) solution that can be managed through a browser-based "Data Center Designer" (DCD) tool or via an easy to use API.

The API allows you to create additional PostgreSQL database clusters or modify existing ones. It is designed to allow users to leverage the same power and flexibility found within the DCD visual tool. Both tools are consistent with their concepts and lend well to making the experience smooth and intuitive.

This Python package is automatically generated by the OpenAPI Generator project:

• API version: 1.0.0
• Package version: 3.0.0
• Generator version: 7.13.0-SNAPSHOT
• Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.9+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/ionos-cloud/sdk-python.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/ionos-cloud/sdk-python.git)

Then import the package:

import ionoscloud_dbaas_postgres

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import ionoscloud_dbaas_postgres

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import ionoscloud_dbaas_postgres
from ionoscloud_dbaas_postgres.rest import ApiException
from pprint import pprint
import os

# 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.BackupsApi(api_client)
    cluster_id = '498ae72f-411f-11eb-9d07-046c59cc737e' # str | The unique ID of the cluster.
    limit = 100 # int | The maximum number of elements to return. Use together with 'offset' for pagination. (optional) (default to 100)
    offset = 0 # int | The first element to return. Use together with 'limit' for pagination. (optional) (default to 0)

    try:
        # List backups of cluster
        api_response = api_instance.cluster_backups_get(cluster_id, limit=limit, offset=offset)
        print("The response of BackupsApi->cluster_backups_get:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling BackupsApi->cluster_backups_get: %s\n" % e)

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
BackupsApi	cluster_backups_get	GET /clusters/{clusterId}/backups	List backups of cluster
BackupsApi	clusters_backups_find_by_id	GET /clusters/backups/{backupId}	Fetch a cluster backup
BackupsApi	clusters_backups_get	GET /clusters/backups	List cluster backups
ClustersApi	cluster_postgres_versions_get	GET /clusters/{clusterId}/postgresversions	List PostgreSQL versions
ClustersApi	clusters_delete	DELETE /clusters/{clusterId}	Delete a cluster
ClustersApi	clusters_find_by_id	GET /clusters/{clusterId}	Fetch a cluster
ClustersApi	clusters_get	GET /clusters	List clusters
ClustersApi	clusters_patch	PATCH /clusters/{clusterId}	Patch a cluster
ClustersApi	clusters_post	POST /clusters	Create a cluster
ClustersApi	clusters_versions_get	GET /clusters/{clusterId}/versions	Supported PostgreSQL versions of cluster
ClustersApi	postgres_versions_get	GET /clusters/postgresversions	List all PostgreSQL versions
DatabasesApi	databases_delete	DELETE /clusters/{clusterId}/databases/{databasename}	Delete database
DatabasesApi	databases_get	GET /clusters/{clusterId}/databases/{databasename}	Get database
DatabasesApi	databases_list	GET /clusters/{clusterId}/databases	List databases
DatabasesApi	databases_post	POST /clusters/{clusterId}/databases	Create a database
LogsApi	cluster_logs_get	GET /clusters/{clusterId}/logs	Get logs of your cluster
MetadataApi	infos_version_get	GET /infos/version	Get the current API version
MetadataApi	infos_versions_get	GET /infos/versions	Fetch all API versions
MetadataApi	versions_get	GET /versions	PostgreSQL versions for new clusters
RestoresApi	cluster_restore_post	POST /clusters/{clusterId}/restore	In-place restore of a cluster
UsersApi	users_delete	DELETE /clusters/{clusterId}/users/{username}	Delete user
UsersApi	users_get	GET /clusters/{clusterId}/users/{username}	Get user
UsersApi	users_list	GET /clusters/{clusterId}/users	List users
UsersApi	users_patch	PATCH /clusters/{clusterId}/users/{username}	Patch user
UsersApi	users_post	POST /clusters/{clusterId}/users	Create a user

Documentation For Models

• APIVersion
• BackupMetadata
• BackupResponse
• ClusterBackup
• ClusterBackupList
• ClusterList
• ClusterLogs
• ClusterLogsInstancesInner
• ClusterLogsInstancesInnerMessagesInner
• ClusterMetadata
• ClusterProperties
• ClusterResponse
• Connection
• ConnectionPooler
• CreateClusterProperties
• CreateClusterRequest
• CreateRestoreRequest
• CreateSynchronizationMode
• DBUser
• Database
• DatabaseItems
• DatabaseList
• DatabaseProperties
• DatabaseResource
• DayOfTheWeek
• DeprecatedPagination
• ErrorMessage
• ErrorResponse
• MaintenanceWindow
• Metadata
• Pagination
• PaginationLinks
• PatchClusterProperties
• PatchClusterRequest
• PatchUserProperties
• PoolMode
• PostgresVersionList
• PostgresVersionListDataInner
• Resource
• ResourceMetadata
• ResourceType
• State
• StorageType
• SynchronizationMode
• User
• UserItems
• UserList
• UserProperties
• UserResource
• UsersPatchRequest

Documentation For Authorization

Authentication schemes defined for the API:

basicAuth

• Type: HTTP basic authentication

tokenAuth

• Type: API key
• API key parameter name: Authorization
• Location: HTTP header

Author