[](https://github.com/ionos-cloud/sdk-resources/actions/workflows/ci-dbaas-mongo-python.yml)
[](https://gitter.im/ionos-cloud/sdk-general)
[](https://sonarcloud.io/summary?id=sdk-python-dbaas-mongo)
[](https://sonarcloud.io/summary/new_code?id=sdk-python-dbaas-mongo)
[](https://sonarcloud.io/summary/new_code?id=sdk-python-dbaas-mongo)
[](https://sonarcloud.io/summary/new_code?id=sdk-python-dbaas-mongo)
[](https://sonarcloud.io/summary/new_code?id=sdk-python-dbaas-mongo)
[](https://sonarcloud.io/summary/new_code?id=sdk-python-dbaas-mongo)
[](https://github.com/ionos-cloud/sdk-python-dbaas-mongo/releases/latest)
[](https://github.com/ionos-cloud/sdk-python-dbaas-mongo/releases/latest)
[](https://pypi.org/project/ionoscloud-dbaas-mongo/)
# Python API client for ionoscloud_dbaas_mongo
With IONOS Cloud Database as a Service, you have the ability to quickly set up and manage a MongoDB database. You can also delete clusters, manage backups and users via the API.
MongoDB is an open source, cross-platform, document-oriented database program. Classified as a NoSQL database program, it uses JSON-like documents with optional schemas.
The MongoDB API allows you to create additional database clusters or modify existing ones. Both tools, the Data Center Designer (DCD) and the API use the same concepts consistently and are well suited for smooth and intuitive use.
## Overview
The 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 & 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-mongo
```
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-mongo.git
```
Note: you may need to run `pip` with root permission: `sudo pip install git+https://github.com/ionos-cloud/sdk-python-dbaas-mongo.git`
Then import the package:
```python
import ionoscloud_dbaas_mongo
```
### 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_mongo
```
> **_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_mongo.Configuration(
username='YOUR_USERNAME',
password='YOUR_PASSWORD',
token='YOUR_TOKEN'
)
client = ionoscloud_dbaas_mongo.ApiClient(configuration)
```
Environment variables can also be used. This is an example of how one would do that:
```python
import os
configuration = ionoscloud_dbaas_mongo.Configuration(
username=os.environ.get('IONOS_USERNAME'),
password=os.environ.get('IONOS_PASSWORD'),
token=os.environ.get('IONOS_TOKEN')
)
client = ionoscloud_dbaas_mongo.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
### Changing the base URL
Base URL for the HTTP operation can be changed in the following way:
```python
import os
configuration = ionoscloud_dbaas_mongo.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_mongo.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://api.ionos.com/databases/mongodb*
<details >
<summary title="Click to toggle">API Endpoints table</summary>
| Class | Method | HTTP request | Description |
| ------------- | ------------- | ------------- | ------------- |
| 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} | Get a cluster by id |
| ClustersApi | [**clusters_get**](docs/api/ClustersApi.md#clusters_get) | **GET** /clusters | Get Clusters |
| ClustersApi | [**clusters_patch**](docs/api/ClustersApi.md#clusters_patch) | **PATCH** /clusters/{clusterId} | Patch a cluster |
| ClustersApi | [**clusters_post**](docs/api/ClustersApi.md#clusters_post) | **POST** /clusters | Create a Cluster |
| LogsApi | [**clusters_logs_get**](docs/api/LogsApi.md#clusters_logs_get) | **GET** /clusters/{clusterId}/logs | Get logs of your cluster |
| MetadataApi | [**infos_version_get**](docs/api/MetadataApi.md#infos_version_get) | **GET** /infos/version | Get API Version |
| MetadataApi | [**infos_versions_get**](docs/api/MetadataApi.md#infos_versions_get) | **GET** /infos/versions | Get All API Versions |
| RestoresApi | [**clusters_restore_post**](docs/api/RestoresApi.md#clusters_restore_post) | **POST** /clusters/{clusterId}/restore | In-place restore of a cluster |
| SnapshotsApi | [**clusters_snapshots_get**](docs/api/SnapshotsApi.md#clusters_snapshots_get) | **GET** /clusters/{clusterId}/snapshots | Get the snapshots of your cluster |
| TemplatesApi | [**templates_get**](docs/api/TemplatesApi.md#templates_get) | **GET** /templates | Get Templates |
| UsersApi | [**clusters_users_delete**](docs/api/UsersApi.md#clusters_users_delete) | **DELETE** /clusters/{clusterId}/users/{username} | Delete a MongoDB User by ID |
| UsersApi | [**clusters_users_find_by_id**](docs/api/UsersApi.md#clusters_users_find_by_id) | **GET** /clusters/{clusterId}/users/{username} | Get a MongoDB User by ID |
| UsersApi | [**clusters_users_get**](docs/api/UsersApi.md#clusters_users_get) | **GET** /clusters/{clusterId}/users | Get all Cluster Users |
| UsersApi | [**clusters_users_patch**](docs/api/UsersApi.md#clusters_users_patch) | **PATCH** /clusters/{clusterId}/users/{username} | Patch a MongoDB User by ID |
| UsersApi | [**clusters_users_post**](docs/api/UsersApi.md#clusters_users_post) | **POST** /clusters/{clusterId}/users | Create MongoDB User |
</details>
## Documentation For Models
All URIs are relative to *https://api.ionos.com/databases/mongodb*
<details >
<summary title="Click to toggle">API models list</summary>
- [APIVersion](docs/models/APIVersion)
- [ClusterList](docs/models/ClusterList)
- [ClusterListAllOf](docs/models/ClusterListAllOf)
- [ClusterLogs](docs/models/ClusterLogs)
- [ClusterLogsInstances](docs/models/ClusterLogsInstances)
- [ClusterLogsMessages](docs/models/ClusterLogsMessages)
- [ClusterProperties](docs/models/ClusterProperties)
- [ClusterResponse](docs/models/ClusterResponse)
- [Connection](docs/models/Connection)
- [CreateClusterProperties](docs/models/CreateClusterProperties)
- [CreateClusterRequest](docs/models/CreateClusterRequest)
- [CreateRestoreRequest](docs/models/CreateRestoreRequest)
- [DayOfTheWeek](docs/models/DayOfTheWeek)
- [ErrorMessage](docs/models/ErrorMessage)
- [ErrorResponse](docs/models/ErrorResponse)
- [Health](docs/models/Health)
- [MaintenanceWindow](docs/models/MaintenanceWindow)
- [Metadata](docs/models/Metadata)
- [Pagination](docs/models/Pagination)
- [PaginationLinks](docs/models/PaginationLinks)
- [PatchClusterProperties](docs/models/PatchClusterProperties)
- [PatchClusterRequest](docs/models/PatchClusterRequest)
- [PatchUserProperties](docs/models/PatchUserProperties)
- [PatchUserRequest](docs/models/PatchUserRequest)
- [ResourceType](docs/models/ResourceType)
- [SnapshotList](docs/models/SnapshotList)
- [SnapshotListAllOf](docs/models/SnapshotListAllOf)
- [SnapshotProperties](docs/models/SnapshotProperties)
- [SnapshotResponse](docs/models/SnapshotResponse)
- [State](docs/models/State)
- [TemplateList](docs/models/TemplateList)
- [TemplateListAllOf](docs/models/TemplateListAllOf)
- [TemplateProperties](docs/models/TemplateProperties)
- [TemplateResponse](docs/models/TemplateResponse)
- [User](docs/models/User)
- [UserMetadata](docs/models/UserMetadata)
- [UserProperties](docs/models/UserProperties)
- [UserRoles](docs/models/UserRoles)
- [UsersList](docs/models/UsersList)
[[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-mongo",
"name": "ionoscloud-dbaas-mongo",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "OpenAPI,OpenAPI-Generator,IONOS DBaaS MongoDB REST API",
"author": "Ionos Cloud",
"author_email": "sdk@cloud.ionos.com",
"download_url": "https://files.pythonhosted.org/packages/27/3b/122b8a71b0c44f6c294d9af857869770f04c7f19c4f41ec678f1ae7e6066/ionoscloud-dbaas-mongo-1.2.2.tar.gz",
"platform": null,
"description": "[](https://github.com/ionos-cloud/sdk-resources/actions/workflows/ci-dbaas-mongo-python.yml)\n[](https://gitter.im/ionos-cloud/sdk-general)\n[](https://sonarcloud.io/summary?id=sdk-python-dbaas-mongo)\n[](https://sonarcloud.io/summary/new_code?id=sdk-python-dbaas-mongo)\n[](https://sonarcloud.io/summary/new_code?id=sdk-python-dbaas-mongo)\n[](https://sonarcloud.io/summary/new_code?id=sdk-python-dbaas-mongo)\n[](https://sonarcloud.io/summary/new_code?id=sdk-python-dbaas-mongo)\n[](https://sonarcloud.io/summary/new_code?id=sdk-python-dbaas-mongo)\n[](https://github.com/ionos-cloud/sdk-python-dbaas-mongo/releases/latest)\n[](https://github.com/ionos-cloud/sdk-python-dbaas-mongo/releases/latest)\n[](https://pypi.org/project/ionoscloud-dbaas-mongo/)\n\n![Alt text](.github/IONOS.CLOUD.BLU.svg?raw=true \"Title\")\n\n\n# Python API client for ionoscloud_dbaas_mongo\n\nWith IONOS Cloud Database as a Service, you have the ability to quickly set up and manage a MongoDB database. You can also delete clusters, manage backups and users via the API.\n\nMongoDB is an open source, cross-platform, document-oriented database program. Classified as a NoSQL database program, it uses JSON-like documents with optional schemas.\n\nThe MongoDB API allows you to create additional database clusters or modify existing ones. Both tools, the Data Center Designer (DCD) and the API use the same concepts consistently and are well suited for smooth and intuitive use.\n\n\n## Overview\nThe 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.\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-mongo\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-mongo.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-mongo.git`\n\nThen import the package:\n\n```python\nimport ionoscloud_dbaas_mongo\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_mongo\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_mongo.Configuration(\n username='YOUR_USERNAME',\n password='YOUR_PASSWORD',\n token='YOUR_TOKEN'\n )\nclient = ionoscloud_dbaas_mongo.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_mongo.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_mongo.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\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_mongo.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_mongo.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://api.ionos.com/databases/mongodb*\n<details >\n <summary title=\"Click to toggle\">API Endpoints table</summary>\n\n\n| Class | Method | HTTP request | Description |\n| ------------- | ------------- | ------------- | ------------- |\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} | Get a cluster by id |\n| ClustersApi | [**clusters_get**](docs/api/ClustersApi.md#clusters_get) | **GET** /clusters | Get Clusters |\n| ClustersApi | [**clusters_patch**](docs/api/ClustersApi.md#clusters_patch) | **PATCH** /clusters/{clusterId} | Patch a cluster |\n| ClustersApi | [**clusters_post**](docs/api/ClustersApi.md#clusters_post) | **POST** /clusters | Create a Cluster |\n| LogsApi | [**clusters_logs_get**](docs/api/LogsApi.md#clusters_logs_get) | **GET** /clusters/{clusterId}/logs | Get logs of your cluster |\n| MetadataApi | [**infos_version_get**](docs/api/MetadataApi.md#infos_version_get) | **GET** /infos/version | Get API Version |\n| MetadataApi | [**infos_versions_get**](docs/api/MetadataApi.md#infos_versions_get) | **GET** /infos/versions | Get All API Versions |\n| RestoresApi | [**clusters_restore_post**](docs/api/RestoresApi.md#clusters_restore_post) | **POST** /clusters/{clusterId}/restore | In-place restore of a cluster |\n| SnapshotsApi | [**clusters_snapshots_get**](docs/api/SnapshotsApi.md#clusters_snapshots_get) | **GET** /clusters/{clusterId}/snapshots | Get the snapshots of your cluster |\n| TemplatesApi | [**templates_get**](docs/api/TemplatesApi.md#templates_get) | **GET** /templates | Get Templates |\n| UsersApi | [**clusters_users_delete**](docs/api/UsersApi.md#clusters_users_delete) | **DELETE** /clusters/{clusterId}/users/{username} | Delete a MongoDB User by ID |\n| UsersApi | [**clusters_users_find_by_id**](docs/api/UsersApi.md#clusters_users_find_by_id) | **GET** /clusters/{clusterId}/users/{username} | Get a MongoDB User by ID |\n| UsersApi | [**clusters_users_get**](docs/api/UsersApi.md#clusters_users_get) | **GET** /clusters/{clusterId}/users | Get all Cluster Users |\n| UsersApi | [**clusters_users_patch**](docs/api/UsersApi.md#clusters_users_patch) | **PATCH** /clusters/{clusterId}/users/{username} | Patch a MongoDB User by ID |\n| UsersApi | [**clusters_users_post**](docs/api/UsersApi.md#clusters_users_post) | **POST** /clusters/{clusterId}/users | Create MongoDB User |\n\n</details>\n\n## Documentation For Models\n\nAll URIs are relative to *https://api.ionos.com/databases/mongodb*\n<details >\n<summary title=\"Click to toggle\">API models list</summary>\n\n - [APIVersion](docs/models/APIVersion)\n - [ClusterList](docs/models/ClusterList)\n - [ClusterListAllOf](docs/models/ClusterListAllOf)\n - [ClusterLogs](docs/models/ClusterLogs)\n - [ClusterLogsInstances](docs/models/ClusterLogsInstances)\n - [ClusterLogsMessages](docs/models/ClusterLogsMessages)\n - [ClusterProperties](docs/models/ClusterProperties)\n - [ClusterResponse](docs/models/ClusterResponse)\n - [Connection](docs/models/Connection)\n - [CreateClusterProperties](docs/models/CreateClusterProperties)\n - [CreateClusterRequest](docs/models/CreateClusterRequest)\n - [CreateRestoreRequest](docs/models/CreateRestoreRequest)\n - [DayOfTheWeek](docs/models/DayOfTheWeek)\n - [ErrorMessage](docs/models/ErrorMessage)\n - [ErrorResponse](docs/models/ErrorResponse)\n - [Health](docs/models/Health)\n - [MaintenanceWindow](docs/models/MaintenanceWindow)\n - [Metadata](docs/models/Metadata)\n - [Pagination](docs/models/Pagination)\n - [PaginationLinks](docs/models/PaginationLinks)\n - [PatchClusterProperties](docs/models/PatchClusterProperties)\n - [PatchClusterRequest](docs/models/PatchClusterRequest)\n - [PatchUserProperties](docs/models/PatchUserProperties)\n - [PatchUserRequest](docs/models/PatchUserRequest)\n - [ResourceType](docs/models/ResourceType)\n - [SnapshotList](docs/models/SnapshotList)\n - [SnapshotListAllOf](docs/models/SnapshotListAllOf)\n - [SnapshotProperties](docs/models/SnapshotProperties)\n - [SnapshotResponse](docs/models/SnapshotResponse)\n - [State](docs/models/State)\n - [TemplateList](docs/models/TemplateList)\n - [TemplateListAllOf](docs/models/TemplateListAllOf)\n - [TemplateProperties](docs/models/TemplateProperties)\n - [TemplateResponse](docs/models/TemplateResponse)\n - [User](docs/models/User)\n - [UserMetadata](docs/models/UserMetadata)\n - [UserProperties](docs/models/UserProperties)\n - [UserRoles](docs/models/UserRoles)\n - [UsersList](docs/models/UsersList)\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": "",
"summary": "Python SDK for the Ionos DBaaS MongoDB API",
"version": "1.2.2",
"split_keywords": [
"openapi",
"openapi-generator",
"ionos dbaas mongodb rest api"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9cc83eb10e389c2bedca44ab93fa0900b94136da08ca76bba7c24555ae77b05b",
"md5": "bbb12a97e6584f06af4dde9ff1d03db0",
"sha256": "4230f72f855ebef1c22e70d6efcd2bbf916cfefd268a4d880ea8de6cb2ff1dd7"
},
"downloads": -1,
"filename": "ionoscloud_dbaas_mongo-1.2.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "bbb12a97e6584f06af4dde9ff1d03db0",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 118157,
"upload_time": "2023-03-24T12:18:43",
"upload_time_iso_8601": "2023-03-24T12:18:43.759726Z",
"url": "https://files.pythonhosted.org/packages/9c/c8/3eb10e389c2bedca44ab93fa0900b94136da08ca76bba7c24555ae77b05b/ionoscloud_dbaas_mongo-1.2.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "273b122b8a71b0c44f6c294d9af857869770f04c7f19c4f41ec678f1ae7e6066",
"md5": "c23c5c9cece2d94b83c8342fd4291b8f",
"sha256": "1f0ce39b29465c9cb1fd9575a201e6834d108ce7c59b41e5027d87d5be028f2a"
},
"downloads": -1,
"filename": "ionoscloud-dbaas-mongo-1.2.2.tar.gz",
"has_sig": false,
"md5_digest": "c23c5c9cece2d94b83c8342fd4291b8f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 51922,
"upload_time": "2023-03-24T12:18:45",
"upload_time_iso_8601": "2023-03-24T12:18:45.943199Z",
"url": "https://files.pythonhosted.org/packages/27/3b/122b8a71b0c44f6c294d9af857869770f04c7f19c4f41ec678f1ae7e6066/ionoscloud-dbaas-mongo-1.2.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-03-24 12:18:45",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "ionos-cloud",
"github_project": "sdk-python-dbaas-mongo",
"travis_ci": true,
"coveralls": false,
"github_actions": true,
"requirements": [],
"tox": true,
"lcname": "ionoscloud-dbaas-mongo"
}
JSON
