[](https://gitter.im/ionos-cloud/sdk-general)
[](https://sonarcloud.io/summary?id=sdk-python-dbaas-mariadb)
[](https://sonarcloud.io/summary/new_code?id=sdk-python-dbaas-mariadb)
[](https://sonarcloud.io/summary/new_code?id=sdk-python-dbaas-mariadb)
[](https://sonarcloud.io/summary/new_code?id=sdk-python-dbaas-mariadb)
[](https://sonarcloud.io/summary/new_code?id=sdk-python-dbaas-mariadb)
[](https://sonarcloud.io/summary/new_code?id=sdk-python-dbaas-mariadb)
[](https://github.com/ionos-cloud/sdk-python-dbaas-mariadb/releases/latest)
[](https://github.com/ionos-cloud/sdk-python-dbaas-mariadb/releases/latest)
[](https://pypi.org/project/ionoscloud-dbaas-mariadb/)
# Python API client for ionoscloud_dbaas_mariadb
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 MariaDB 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.
## Overview
The IONOS Cloud SDK for Python provides you with access to the IONOS Cloud 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 & Usage
**Requirements:**
- Python >= 3.5
### pip install
Since this package is hosted on [Pypi](https://pypi.org/) you can install it by using:
```bash
pip install ionoscloud-dbaas-mariadb
```
If the python package is hosted on a repository, you can install directly using:
```bash
pip install git+https://github.com/ionos-cloud/sdk-python-dbaas-mariadb.git
```
Note: you may need to run `pip` with root permission: `sudo pip install git+https://github.com/ionos-cloud/sdk-python-dbaas-mariadb.git`
Then import the package:
```python
import ionoscloud_dbaas_mariadb
```
### Setuptools
Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
```bash
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_mariadb
```
> **_NOTE:_** The Python SDK does not support Python 2. It only supports Python >= 3.5.
### Authentication
The username and password **or** the authentication token can be manually specified when initializing the SDK client:
```python
configuration = ionoscloud_dbaas_mariadb.Configuration(
username='YOUR_USERNAME',
password='YOUR_PASSWORD',
token='YOUR_TOKEN'
)
client = ionoscloud_dbaas_mariadb.ApiClient(configuration)
```
Environment variables can also be used. This is an example of how one would do that:
```python
import os
configuration = ionoscloud_dbaas_mariadb.Configuration(
username=os.environ.get('IONOS_USERNAME'),
password=os.environ.get('IONOS_PASSWORD'),
token=os.environ.get('IONOS_TOKEN')
)
client = ionoscloud_dbaas_mariadb.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 proxies
You can use http proxies by setting the following environment variables:
- `IONOS_HTTP_PROXY` - proxy URL
- `IONOS_HTTP_PROXY_HEADERS` - proxy headers
Each line in `IONOS_HTTP_PROXY_HEADERS` represents one header, where the header name and value is separated by a colon. Newline characters within a value need to be escaped. See this example:
```
Connection: Keep-Alive
User-Info: MyID
User-Group: my long\nheader value
```
### Changing the base URL
Base URL for the HTTP operation can be changed in the following way:
```python
import os
configuration = ionoscloud_dbaas_mariadb.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_mariadb.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 Endpoints
All URIs are relative to *https://mariadb.de-txl.ionos.com*
<details >
<summary title="Click to toggle">API Endpoints table</summary>
| Class | Method | HTTP request | Description |
| ------------- | ------------- | ------------- | ------------- |
| BackupsApi | [**backups_find_by_id**](docs/api/BackupsApi.md#backups_find_by_id) | **GET** /backups/{backupId} | Fetch a cluster's backups |
| BackupsApi | [**backups_get**](docs/api/BackupsApi.md#backups_get) | **GET** /backups | List of cluster's backups. |
| BackupsApi | [**cluster_backups_get**](docs/api/BackupsApi.md#cluster_backups_get) | **GET** /clusters/{clusterId}/backups | List backups of cluster |
| ClustersApi | [**clusters_delete**](docs/api/ClustersApi.md#clusters_delete) | **DELETE** /clusters/{clusterId} | Delete a cluster |
| ClustersApi | [**clusters_find_by_id**](docs/api/ClustersApi.md#clusters_find_by_id) | **GET** /clusters/{clusterId} | Fetch a cluster |
| ClustersApi | [**clusters_get**](docs/api/ClustersApi.md#clusters_get) | **GET** /clusters | List clusters |
| ClustersApi | [**clusters_post**](docs/api/ClustersApi.md#clusters_post) | **POST** /clusters | Create a cluster |
</details>
## Documentation For Models
All URIs are relative to *https://mariadb.de-txl.ionos.com*
<details >
<summary title="Click to toggle">API models list</summary>
- [Backup](docs/models/Backup)
- [BackupList](docs/models/BackupList)
- [BackupListAllOf](docs/models/BackupListAllOf)
- [BackupResponse](docs/models/BackupResponse)
- [BaseBackup](docs/models/BaseBackup)
- [ClusterList](docs/models/ClusterList)
- [ClusterListAllOf](docs/models/ClusterListAllOf)
- [ClusterMetadata](docs/models/ClusterMetadata)
- [ClusterProperties](docs/models/ClusterProperties)
- [ClusterResponse](docs/models/ClusterResponse)
- [ClustersGet400Response](docs/models/ClustersGet400Response)
- [ClustersGet401Response](docs/models/ClustersGet401Response)
- [ClustersGet403Response](docs/models/ClustersGet403Response)
- [ClustersGet404Response](docs/models/ClustersGet404Response)
- [ClustersGet405Response](docs/models/ClustersGet405Response)
- [ClustersGet415Response](docs/models/ClustersGet415Response)
- [ClustersGet422Response](docs/models/ClustersGet422Response)
- [ClustersGet429Response](docs/models/ClustersGet429Response)
- [ClustersGet500Response](docs/models/ClustersGet500Response)
- [ClustersGet503Response](docs/models/ClustersGet503Response)
- [Connection](docs/models/Connection)
- [CreateClusterProperties](docs/models/CreateClusterProperties)
- [CreateClusterRequest](docs/models/CreateClusterRequest)
- [DBUser](docs/models/DBUser)
- [DayOfTheWeek](docs/models/DayOfTheWeek)
- [ErrorMessage](docs/models/ErrorMessage)
- [MaintenanceWindow](docs/models/MaintenanceWindow)
- [MariadbVersion](docs/models/MariadbVersion)
- [Pagination](docs/models/Pagination)
- [PaginationLinks](docs/models/PaginationLinks)
- [State](docs/models/State)
[[Back to API list]](#documentation-for-api-endpoints) [[Back to Model list]](#documentation-for-models)
</details>
Raw data
{
"_id": null,
"home_page": "https://github.com/ionos-cloud/sdk-python-dbaas-mariadb",
"name": "ionoscloud-dbaas-mariadb",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "OpenAPI, OpenAPI-Generator, IONOS DBaaS MariaDB REST API",
"author": "Ionos Cloud",
"author_email": "sdk@cloud.ionos.com",
"download_url": "https://files.pythonhosted.org/packages/72/e8/812810aef1662930f9c50d74ecdb7810207640f5fcd00e9be4920d54d198/ionoscloud-dbaas-mariadb-1.0.0.tar.gz",
"platform": null,
"description": "[](https://gitter.im/ionos-cloud/sdk-general)\n[](https://sonarcloud.io/summary?id=sdk-python-dbaas-mariadb)\n[](https://sonarcloud.io/summary/new_code?id=sdk-python-dbaas-mariadb)\n[](https://sonarcloud.io/summary/new_code?id=sdk-python-dbaas-mariadb)\n[](https://sonarcloud.io/summary/new_code?id=sdk-python-dbaas-mariadb)\n[](https://sonarcloud.io/summary/new_code?id=sdk-python-dbaas-mariadb)\n[](https://sonarcloud.io/summary/new_code?id=sdk-python-dbaas-mariadb)\n[](https://github.com/ionos-cloud/sdk-python-dbaas-mariadb/releases/latest)\n[](https://github.com/ionos-cloud/sdk-python-dbaas-mariadb/releases/latest)\n[](https://pypi.org/project/ionoscloud-dbaas-mariadb/)\n\n![Alt text](.github/IONOS.CLOUD.BLU.svg?raw=true \"Title\")\n\n\n# Python API client for ionoscloud_dbaas_mariadb\n\nAn enterprise-grade Database is provided as a Service (DBaaS) solution that\ncan be managed through a browser-based \\\"Data Center Designer\\\" (DCD) tool or\nvia an easy to use API.\n\nThe API allows you to create additional MariaDB database clusters or modify existing\nones. It is designed to allow users to leverage the same power and\nflexibility found within the DCD visual tool. Both tools are consistent with\ntheir concepts and lend well to making the experience smooth and intuitive.\n\n\n## Overview\nThe IONOS Cloud SDK for Python provides you with access to the IONOS Cloud 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.\n\n\n### Installation & Usage\n\n**Requirements:**\n- Python >= 3.5\n\n### pip install\n\nSince this package is hosted on [Pypi](https://pypi.org/) you can install it by using:\n\n```bash\npip install ionoscloud-dbaas-mariadb\n```\n\nIf the python package is hosted on a repository, you can install directly using:\n\n```bash\npip install git+https://github.com/ionos-cloud/sdk-python-dbaas-mariadb.git\n```\n\nNote: you may need to run `pip` with root permission: `sudo pip install git+https://github.com/ionos-cloud/sdk-python-dbaas-mariadb.git`\n\nThen import the package:\n\n```python\nimport ionoscloud_dbaas_mariadb\n```\n\n### Setuptools\n\nInstall via [Setuptools](http://pypi.python.org/pypi/setuptools).\n\n```bash\npython setup.py install --user\n```\n\nor `sudo python setup.py install` to install the package for all users\n\nThen import the package:\n\n```python\nimport ionoscloud_dbaas_mariadb\n```\n\n> **_NOTE:_** The Python SDK does not support Python 2. It only supports Python >= 3.5.\n\n### Authentication\n\nThe username and password **or** the authentication token can be manually specified when initializing the SDK client:\n\n```python\nconfiguration = ionoscloud_dbaas_mariadb.Configuration(\n username='YOUR_USERNAME',\n password='YOUR_PASSWORD',\n token='YOUR_TOKEN'\n )\nclient = ionoscloud_dbaas_mariadb.ApiClient(configuration)\n```\n\nEnvironment variables can also be used. This is an example of how one would do that:\n\n```python\nimport os\n\nconfiguration = ionoscloud_dbaas_mariadb.Configuration(\n username=os.environ.get('IONOS_USERNAME'),\n password=os.environ.get('IONOS_PASSWORD'),\n token=os.environ.get('IONOS_TOKEN')\n )\nclient = ionoscloud_dbaas_mariadb.ApiClient(configuration)\n```\n\n**Warning**: Make sure to follow the Information Security Best Practices when using credentials within your code or storing them in a file.\n\n\n### HTTP proxies\n\nYou can use http proxies by setting the following environment variables:\n- `IONOS_HTTP_PROXY` - proxy URL\n- `IONOS_HTTP_PROXY_HEADERS` - proxy headers\n\nEach line in `IONOS_HTTP_PROXY_HEADERS` represents one header, where the header name and value is separated by a colon. Newline characters within a value need to be escaped. See this example:\n```\nConnection: Keep-Alive\nUser-Info: MyID\nUser-Group: my long\\nheader value\n```\n\n\n### Changing the base URL\n\nBase URL for the HTTP operation can be changed in the following way:\n\n```python\nimport os\n\nconfiguration = ionoscloud_dbaas_mariadb.Configuration(\n username=os.environ.get('IONOS_USERNAME'),\n password=os.environ.get('IONOS_PASSWORD'),\n host=os.environ.get('IONOS_API_URL'),\n server_index=None,\n )\nclient = ionoscloud_dbaas_mariadb.ApiClient(configuration)\n```\n\n## Certificate pinning:\n\nYou can enable certificate pinning if you want to bypass the normal certificate checking procedure,\nby doing the following:\n\nSet env variable IONOS_PINNED_CERT=<insert_sha256_public_fingerprint_here>\n\nYou can get the sha256 fingerprint most easily from the browser by inspecting the certificate.\n\n\n## Documentation for API Endpoints\n\nAll URIs are relative to *https://mariadb.de-txl.ionos.com*\n<details >\n <summary title=\"Click to toggle\">API Endpoints table</summary>\n\n\n| Class | Method | HTTP request | Description |\n| ------------- | ------------- | ------------- | ------------- |\n| BackupsApi | [**backups_find_by_id**](docs/api/BackupsApi.md#backups_find_by_id) | **GET** /backups/{backupId} | Fetch a cluster's backups |\n| BackupsApi | [**backups_get**](docs/api/BackupsApi.md#backups_get) | **GET** /backups | List of cluster's backups. |\n| BackupsApi | [**cluster_backups_get**](docs/api/BackupsApi.md#cluster_backups_get) | **GET** /clusters/{clusterId}/backups | List backups of cluster |\n| ClustersApi | [**clusters_delete**](docs/api/ClustersApi.md#clusters_delete) | **DELETE** /clusters/{clusterId} | Delete a cluster |\n| ClustersApi | [**clusters_find_by_id**](docs/api/ClustersApi.md#clusters_find_by_id) | **GET** /clusters/{clusterId} | Fetch a cluster |\n| ClustersApi | [**clusters_get**](docs/api/ClustersApi.md#clusters_get) | **GET** /clusters | List clusters |\n| ClustersApi | [**clusters_post**](docs/api/ClustersApi.md#clusters_post) | **POST** /clusters | Create a cluster |\n\n</details>\n\n## Documentation For Models\n\nAll URIs are relative to *https://mariadb.de-txl.ionos.com*\n<details >\n<summary title=\"Click to toggle\">API models list</summary>\n\n - [Backup](docs/models/Backup)\n - [BackupList](docs/models/BackupList)\n - [BackupListAllOf](docs/models/BackupListAllOf)\n - [BackupResponse](docs/models/BackupResponse)\n - [BaseBackup](docs/models/BaseBackup)\n - [ClusterList](docs/models/ClusterList)\n - [ClusterListAllOf](docs/models/ClusterListAllOf)\n - [ClusterMetadata](docs/models/ClusterMetadata)\n - [ClusterProperties](docs/models/ClusterProperties)\n - [ClusterResponse](docs/models/ClusterResponse)\n - [ClustersGet400Response](docs/models/ClustersGet400Response)\n - [ClustersGet401Response](docs/models/ClustersGet401Response)\n - [ClustersGet403Response](docs/models/ClustersGet403Response)\n - [ClustersGet404Response](docs/models/ClustersGet404Response)\n - [ClustersGet405Response](docs/models/ClustersGet405Response)\n - [ClustersGet415Response](docs/models/ClustersGet415Response)\n - [ClustersGet422Response](docs/models/ClustersGet422Response)\n - [ClustersGet429Response](docs/models/ClustersGet429Response)\n - [ClustersGet500Response](docs/models/ClustersGet500Response)\n - [ClustersGet503Response](docs/models/ClustersGet503Response)\n - [Connection](docs/models/Connection)\n - [CreateClusterProperties](docs/models/CreateClusterProperties)\n - [CreateClusterRequest](docs/models/CreateClusterRequest)\n - [DBUser](docs/models/DBUser)\n - [DayOfTheWeek](docs/models/DayOfTheWeek)\n - [ErrorMessage](docs/models/ErrorMessage)\n - [MaintenanceWindow](docs/models/MaintenanceWindow)\n - [MariadbVersion](docs/models/MariadbVersion)\n - [Pagination](docs/models/Pagination)\n - [PaginationLinks](docs/models/PaginationLinks)\n - [State](docs/models/State)\n\n\n[[Back to API list]](#documentation-for-api-endpoints) [[Back to Model list]](#documentation-for-models)\n\n</details>\n",
"bugtrack_url": null,
"license": null,
"summary": "Python SDK for the ionoscloud-dbaas-mariadb API",
"version": "1.0.0",
"project_urls": {
"Homepage": "https://github.com/ionos-cloud/sdk-python-dbaas-mariadb"
},
"split_keywords": [
"openapi",
" openapi-generator",
" ionos dbaas mariadb rest api"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3c4f3fd2ded9d72723dc654c13d7cae8d368aee12ce1a3d677888903549180b4",
"md5": "15111572aa21f8a2ec32b600cc360603",
"sha256": "42b2e00980fc099a151240728674e2a923cda7ce3867fb30a8995a984bc185b3"
},
"downloads": -1,
"filename": "ionoscloud_dbaas_mariadb-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "15111572aa21f8a2ec32b600cc360603",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 91694,
"upload_time": "2024-03-28T13:50:08",
"upload_time_iso_8601": "2024-03-28T13:50:08.432270Z",
"url": "https://files.pythonhosted.org/packages/3c/4f/3fd2ded9d72723dc654c13d7cae8d368aee12ce1a3d677888903549180b4/ionoscloud_dbaas_mariadb-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "72e8812810aef1662930f9c50d74ecdb7810207640f5fcd00e9be4920d54d198",
"md5": "c5f75183b72c7e1bb57c20150271db43",
"sha256": "b14e54d075a60b6b88d0accaaac686a40cc814d231ee75d9b9968b652a7d7718"
},
"downloads": -1,
"filename": "ionoscloud-dbaas-mariadb-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "c5f75183b72c7e1bb57c20150271db43",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 43687,
"upload_time": "2024-03-28T13:50:10",
"upload_time_iso_8601": "2024-03-28T13:50:10.625091Z",
"url": "https://files.pythonhosted.org/packages/72/e8/812810aef1662930f9c50d74ecdb7810207640f5fcd00e9be4920d54d198/ionoscloud-dbaas-mariadb-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-28 13:50:10",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ionos-cloud",
"github_project": "sdk-python-dbaas-mariadb",
"travis_ci": true,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "certifi",
"specs": [
[
">=",
"14.05.14"
]
]
},
{
"name": "future",
"specs": []
},
{
"name": "six",
"specs": [
[
">=",
"1.10"
]
]
},
{
"name": "python_dateutil",
"specs": [
[
">=",
"2.5.3"
]
]
},
{
"name": "setuptools",
"specs": [
[
">=",
"21.0.0"
]
]
},
{
"name": "urllib3",
"specs": [
[
">=",
"1.15.1"
]
]
},
{
"name": "asn1crypto",
"specs": [
[
">=",
"1.5.1"
]
]
},
{
"name": "pydantic",
"specs": [
[
">=",
"1.10.5"
],
[
"<",
"2"
]
]
}
],
"tox": true,
"lcname": "ionoscloud-dbaas-mariadb"
}
JSON
