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 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
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://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 | GET /backup-locations/{backupLocationId} | Retrieve BackupLocation |
| BackupLocationsApi | backuplocations_get | GET /backup-locations | Retrieve all BackupLocations |
| BackupsApi | backups_find_by_id | GET /backups/{backupId} | Retrieve Backup |
| BackupsApi | backups_get | GET /backups | Retrieve all Backups |
| ClustersApi | clusters_delete | DELETE /clusters/{clusterId} | Delete Cluster |
| ClustersApi | clusters_find_by_id | GET /clusters/{clusterId} | Retrieve Cluster |
| ClustersApi | clusters_get | GET /clusters | Retrieve all Clusters |
| ClustersApi | clusters_post | POST /clusters | Create Cluster |
| ClustersApi | clusters_put | PUT /clusters/{clusterId} | Ensure Cluster |
| VersionsApi | versions_find_by_id | GET /versions/{versionId} | Retrieve PostgresVersion |
| VersionsApi | versions_get | GET /versions | Retrieve all Versions |
Documentation For Models
- Backup
- BackupCreate
- BackupEnsure
- BackupLocation
- BackupLocationRead
- BackupLocationReadList
- BackupRead
- BackupReadList
- Cluster
- ClusterBackup
- ClusterCreate
- ClusterCreateProperties
- ClusterEnsure
- ClusterMetadata
- ClusterRead
- ClusterReadList
- ClusterRestoreFromBackup
- DayOfTheWeek
- Error
- ErrorMessagesInner
- InstanceConfiguration
- Links
- MaintenanceWindow
- Metadata
- Pagination
- PostgresClusterConnection
- PostgresClusterReplicationMode
- PostgresClusterStates
- PostgresInPlaceRestoreClusterFromBackup
- PostgresRestoreClusterFromBackup
- PostgresUser
- PostgresVersion
- PostgresVersionRead
- PostgresVersionReadList
Documentation For Authorization
Authentication schemes defined for the API:
tokenAuth
- Type: Bearer authentication (JWT)
Author
Metadata
Release files for ionoscloud-dbaas-postgres 3.0.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| ionoscloud_dbaas_postgres-3.0.1.tar.gz | 42.7 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| ionoscloud_dbaas_postgres-3.0.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 135.5 kB
Release files / ionoscloud_dbaas_postgres-3.0.1.tar.gz
| Download URL | ionoscloud_dbaas_postgres-3.0.1.tar.gz |
|---|---|
| Size | 42.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
24703e91eb1d71ead7d7a0cde345be936b48eca0298f4a44fcf27aa64d09057f
|
|
BLAKE2b-256 checksum How to use checksums |
10b536682fa856c41d1541d691031a1e497a404e8ecf9be42bc6bca1fe398568
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.11.15
|
Release files / ionoscloud_dbaas_postgres-3.0.1-py3-none-any.whl
| Download URL | ionoscloud_dbaas_postgres-3.0.1-py3-none-any.whl |
|---|---|
| Size | 92.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
5332253abf0fcd4371aad5b7cf66fec81880265bb699435283a951236d32e00b
|
|
BLAKE2b-256 checksum How to use checksums |
ce43aded3821db67dacff27f1e89facb43325d02b1e66a8ed11f6417ee713ed5
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.11.15
|