Metadata-Version: 2.4
Name: ionoscloud_dbaas_postgres
Version: 3.0.1
Summary: IONOS Cloud - DBaas - PostgreSQL
License: NoLicense
License-File: LICENSE
Keywords: OpenAPI,OpenAPI-Generator,IONOS Cloud - DBaas - PostgreSQL
Author: IONOS Cloud Support
Author-email: support@cloud.ionos.com
Requires-Python: >=3.9,<4.0
Classifier: License :: Other/Proprietary License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Requires-Dist: pydantic (>=2)
Requires-Dist: python-dateutil (>=2.8.2)
Requires-Dist: typing-extensions (>=4.7.1)
Requires-Dist: urllib3 (>=2.1.0,<3.0.0)
Project-URL: Repository, https://github.com/ionos-cloud/sdk-python
Description-Content-Type: text/markdown

# ionoscloud-dbaas-postgres
DBaaS PostgreSQL v2 is the new version of the PostgreSQL API at IONOS cloud.


This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: 2.0.0
- Package version: 3.0.1
- Generator version: 7.13.0-SNAPSHOT
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
For more information, please visit [https://docs.ionos.com/cloud/support/general-information/contact-information](https://docs.ionos.com/cloud/support/general-information/contact-information)

## Requirements.

Python 3.9+

## Installation & Usage
### pip install

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

```sh
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:
```python
import ionoscloud_dbaas_postgres
```

### Setuptools

Install via [Setuptools](http://pypi.python.org/pypi/setuptools).

```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)

Then import the package:
```python
import ionoscloud_dbaas_postgres
```

### Tests

Execute `pytest` to run the tests.

## Getting Started

Please follow the [installation procedure](#installation--usage) and then run the following:

```python

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://postgresql.de-txl.ionos.com
# See configuration.py for a list of all supported configuration parameters.
configuration = ionoscloud_dbaas_postgres.Configuration(
    host = "https://postgresql.de-txl.ionos.com"
)

# 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 Bearer authorization (JWT): tokenAuth
configuration = ionoscloud_dbaas_postgres.Configuration(
    token = os.environ["IONOS_TOKEN"]
)


# 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.BackupLocationsApi(api_client)
    backup_location_id = '7fa1dd11-59dd-53a5-ab67-50f649c8e3eb' # str | The ID (UUID) of the BackupLocation.

    try:
        # Retrieve BackupLocation
        api_response = api_instance.backuplocations_find_by_id(backup_location_id)
        print("The response of BackupLocationsApi->backuplocations_find_by_id:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling BackupLocationsApi->backuplocations_find_by_id: %s\n" % e)

```

## Documentation for API Endpoints

All URIs are relative to *https://postgresql.de-txl.ionos.com*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*BackupLocationsApi* | [**backuplocations_find_by_id**](docs/api/BackupLocationsApi.md#backuplocations_find_by_id) | **GET** /backup-locations/{backupLocationId} | Retrieve BackupLocation
*BackupLocationsApi* | [**backuplocations_get**](docs/api/BackupLocationsApi.md#backuplocations_get) | **GET** /backup-locations | Retrieve all BackupLocations
*BackupsApi* | [**backups_find_by_id**](docs/api/BackupsApi.md#backups_find_by_id) | **GET** /backups/{backupId} | Retrieve Backup
*BackupsApi* | [**backups_get**](docs/api/BackupsApi.md#backups_get) | **GET** /backups | Retrieve all Backups
*ClustersApi* | [**clusters_delete**](docs/api/ClustersApi.md#clusters_delete) | **DELETE** /clusters/{clusterId} | Delete Cluster
*ClustersApi* | [**clusters_find_by_id**](docs/api/ClustersApi.md#clusters_find_by_id) | **GET** /clusters/{clusterId} | Retrieve Cluster
*ClustersApi* | [**clusters_get**](docs/api/ClustersApi.md#clusters_get) | **GET** /clusters | Retrieve all Clusters
*ClustersApi* | [**clusters_post**](docs/api/ClustersApi.md#clusters_post) | **POST** /clusters | Create Cluster
*ClustersApi* | [**clusters_put**](docs/api/ClustersApi.md#clusters_put) | **PUT** /clusters/{clusterId} | Ensure Cluster
*VersionsApi* | [**versions_find_by_id**](docs/api/VersionsApi.md#versions_find_by_id) | **GET** /versions/{versionId} | Retrieve PostgresVersion
*VersionsApi* | [**versions_get**](docs/api/VersionsApi.md#versions_get) | **GET** /versions | Retrieve all Versions


## Documentation For Models

 - [Backup](docs/models/Backup.md)
 - [BackupCreate](docs/models/BackupCreate.md)
 - [BackupEnsure](docs/models/BackupEnsure.md)
 - [BackupLocation](docs/models/BackupLocation.md)
 - [BackupLocationRead](docs/models/BackupLocationRead.md)
 - [BackupLocationReadList](docs/models/BackupLocationReadList.md)
 - [BackupRead](docs/models/BackupRead.md)
 - [BackupReadList](docs/models/BackupReadList.md)
 - [Cluster](docs/models/Cluster.md)
 - [ClusterBackup](docs/models/ClusterBackup.md)
 - [ClusterCreate](docs/models/ClusterCreate.md)
 - [ClusterCreateProperties](docs/models/ClusterCreateProperties.md)
 - [ClusterEnsure](docs/models/ClusterEnsure.md)
 - [ClusterMetadata](docs/models/ClusterMetadata.md)
 - [ClusterRead](docs/models/ClusterRead.md)
 - [ClusterReadList](docs/models/ClusterReadList.md)
 - [ClusterRestoreFromBackup](docs/models/ClusterRestoreFromBackup.md)
 - [DayOfTheWeek](docs/models/DayOfTheWeek.md)
 - [Error](docs/models/Error.md)
 - [ErrorMessagesInner](docs/models/ErrorMessagesInner.md)
 - [InstanceConfiguration](docs/models/InstanceConfiguration.md)
 - [Links](docs/models/Links.md)
 - [MaintenanceWindow](docs/models/MaintenanceWindow.md)
 - [Metadata](docs/models/Metadata.md)
 - [Pagination](docs/models/Pagination.md)
 - [PostgresClusterConnection](docs/models/PostgresClusterConnection.md)
 - [PostgresClusterReplicationMode](docs/models/PostgresClusterReplicationMode.md)
 - [PostgresClusterStates](docs/models/PostgresClusterStates.md)
 - [PostgresInPlaceRestoreClusterFromBackup](docs/models/PostgresInPlaceRestoreClusterFromBackup.md)
 - [PostgresRestoreClusterFromBackup](docs/models/PostgresRestoreClusterFromBackup.md)
 - [PostgresUser](docs/models/PostgresUser.md)
 - [PostgresVersion](docs/models/PostgresVersion.md)
 - [PostgresVersionRead](docs/models/PostgresVersionRead.md)
 - [PostgresVersionReadList](docs/models/PostgresVersionReadList.md)


<a id="documentation-for-authorization"></a>
## Documentation For Authorization


Authentication schemes defined for the API:
<a id="tokenAuth"></a>
### tokenAuth

- **Type**: Bearer authentication (JWT)


## Author

support@cloud.ionos.com



