Package: ionoscloud-dbaas-postgres
Python API client for ionoscloud_dbaas_postgresAn 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.OverviewThe IONOS Cloud SDK for Python provides you with access to the IONOS Cloud Dbaas Postgres API. The client library supports both simple and complex requests. It is designed for developers who are building applications in Python. All API operations are performed over SSL and authenticated using your IONOS Cloud portal credentials. The API can be accessed within an instance running in IONOS Cloud or directly over the Internet from any application that can send an HTTPS request and receive an HTTPS response.Installation & UsageRequirements:Python >= 3.5pip installSince this package is hosted onPypiyou can install it by using:pipinstallionoscloud-dbaas-postgresIf the python package is hosted on a repository, you can install directly using:pipinstallgit+https://github.com/ionos-cloud/sdk-python-dbaas-postgres.gitNote: you may need to runpipwith root permission:sudo pip install git+https://github.com/ionos-cloud/sdk-python-dbaas-postgres.gitThen import the package:importionoscloud_dbaas_postgresSetuptoolsInstall viaSetuptools.pythonsetup.pyinstall--userorsudo python setup.py installto install the package for all usersThen import the package:importionoscloud_dbaas_postgresNOTE:The Python SDK does not support Python 2. It only supports Python >= 3.5.AuthenticationThe username and passwordorthe authentication token can be manually specified when initializing the SDK client:configuration=ionoscloud_dbaas_postgres.Configuration(username='YOUR_USERNAME',password='YOUR_PASSWORD',token='YOUR_TOKEN')client=ionoscloud_dbaas_postgres.ApiClient(configuration)Environment variables can also be used. This is an example of how one would do that:importosconfiguration=ionoscloud_dbaas_postgres.Configuration(username=os.environ.get('IONOS_USERNAME'),password=os.environ.get('IONOS_PASSWORD'),token=os.environ.get('IONOS_TOKEN'))client=ionoscloud_dbaas_postgres.ApiClient(configuration)Warning: Make sure to follow the Information Security Best Practices when using credentials within your code or storing them in a file.HTTP proxiesYou can use http proxies by setting the following environment variables:IONOS_HTTP_PROXY- proxy URLIONOS_HTTP_PROXY_HEADERS- proxy headersChanging the base URLBase URL for the HTTP operation can be changed in the following way:importosconfiguration=ionoscloud_dbaas_postgres.Configuration(username=os.environ.get('IONOS_USERNAME'),password=os.environ.get('IONOS_PASSWORD'),host=os.environ.get('IONOS_API_URL'),server_index=None,)client=ionoscloud_dbaas_postgres.ApiClient(configuration)Certificate pinning:You can enable certificate pinning if you want to bypass the normal certificate checking procedure,
by doing the following:Set env variable IONOS_PINNED_CERT=<insert_sha256_public_fingerprint_here>You can get the sha256 fingerprint most easily from the browser by inspecting the certificate.Documentation for API EndpointsAll URIs are relative tohttps://api.ionos.com/databases/postgresqlAPI Endpoints tableClassMethodHTTP requestDescriptionBackupsApicluster_backups_getGET/clusters/{clusterId}/backupsList backups of clusterBackupsApiclusters_backups_find_by_idGET/clusters/backups/{backupId}Fetch a cluster backupBackupsApiclusters_backups_getGET/clusters/backupsList cluster backupsClustersApicluster_postgres_versions_getGET/clusters/{clusterId}/postgresversionsList PostgreSQL versionsClustersApiclusters_deleteDELETE/clusters/{clusterId}Delete a clusterClustersApiclusters_find_by_idGET/clusters/{clusterId}Fetch a clusterClustersApiclusters_getGET/clustersList clustersClustersApiclusters_patchPATCH/clusters/{clusterId}Patch a clusterClustersApiclusters_postPOST/clustersCreate a clusterClustersApipostgres_versions_getGET/clusters/postgresversionsList PostgreSQL versionsDatabasesApidatabases_deleteDELETE/clusters/{clusterId}/databases/{databasename}Delete databaseDatabasesApidatabases_getGET/clusters/{clusterId}/databases/{databasename}Get databaseDatabasesApidatabases_listGET/clusters/{clusterId}/databasesList databasesDatabasesApidatabases_postPOST/clusters/{clusterId}/databasesCreate a databaseLogsApicluster_logs_getGET/clusters/{clusterId}/logsGet logs of your clusterMetadataApiinfos_version_getGET/infos/versionGet the current API versionMetadataApiinfos_versions_getGET/infos/versionsFetch all API versionsRestoresApicluster_restore_postPOST/clusters/{clusterId}/restoreIn-place restore of a clusterUsersApiusers_deleteDELETE/clusters/{clusterId}/users/{username}Delete userUsersApiusers_getGET/clusters/{clusterId}/users/{username}Get userUsersApiusers_listGET/clusters/{clusterId}/usersList usersUsersApiusers_patchPATCH/clusters/{clusterId}/users/{username}Patch userUsersApiusers_postPOST/clusters/{clusterId}/usersCreate a userDocumentation For ModelsAll URIs are relative tohttps://api.ionos.com/databases/postgresqlAPI models listAPIVersionBackupMetadataBackupResponseClusterBackupClusterBackupListClusterBackupListAllOfClusterListClusterListAllOfClusterLogsClusterLogsInstancesClusterLogsInstancesMessagesClusterMetadataClusterPropertiesClusterResponseConnectionCreateClusterPropertiesCreateClusterRequestCreateRestoreRequestDBUserDatabaseDatabaseItemsDatabaseListDatabasePropertiesDatabaseResourceDayOfTheWeekDeprecatedPaginationErrorMessageErrorResponseMaintenanceWindowMetadataPaginationPaginationLinksPatchClusterPropertiesPatchClusterRequestPatchUserPropertiesPostgresVersionListPostgresVersionListDataResourceResourceMetadataResourceTypeStateStorageTypeSynchronizationModeUserUserItemsUserListUserPropertiesUserResourceUsersPatchRequest[Back to API list][Back to Model list]