All URIs are relative to https://api.ionos.com/databases/mongodb
Method
HTTP request
Description
DELETE /clusters/{clusterId}
Delete a Cluster
GET /clusters/{clusterId}
Get a cluster by id
GET /clusters
Get Clusters
PATCH /clusters/{clusterId}
Patch a cluster
POST /clusters
Create a Cluster
clusters_delete
ClusterResponse clusters_delete(cluster_id)
Delete a Cluster
Deletes a MongoDB cluster.
Example
from __future__ import print_function
import time
import ionoscloud_dbaas_mongo
from ionoscloud_dbaas_mongo.rest import ApiException
# Defining the host is optional and defaults to https://api.ionos.com/databases/mongodb
configuration = ionoscloud_dbaas_mongo.Configuration(
host = 'https://api.ionos.com/databases/mongodb',
)
# Example of configuring HTTP Basic Authorization
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
with ionoscloud_dbaas_mongo.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = ionoscloud_dbaas_mongo.ClustersApi(api_client)
cluster_id = 'cluster_id_example' # str | The unique ID of the cluster.
try:
# Delete a Cluster
api_response = api_instance.clusters_delete(cluster_id)
print(api_response)
except ApiException as e:
print('Exception when calling ClustersApi.clusters_delete: %s\n' % e)
from __future__ import print_function
import time
import ionoscloud_dbaas_mongo
from ionoscloud_dbaas_mongo.rest import ApiException
# Defining the host is optional and defaults to https://api.ionos.com/databases/mongodb
configuration = ionoscloud_dbaas_mongo.Configuration(
host = 'https://api.ionos.com/databases/mongodb',
)
# Example of configuring HTTP Basic Authorization
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
with ionoscloud_dbaas_mongo.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = ionoscloud_dbaas_mongo.ClustersApi(api_client)
cluster_id = 'cluster_id_example' # str | The unique ID of the cluster.
try:
# Get a cluster by id
api_response = api_instance.clusters_find_by_id(cluster_id)
print(api_response)
except ApiException as e:
print('Exception when calling ClustersApi.clusters_find_by_id: %s\n' % e)
from __future__ import print_function
import time
import ionoscloud_dbaas_mongo
from ionoscloud_dbaas_mongo.rest import ApiException
# Defining the host is optional and defaults to https://api.ionos.com/databases/mongodb
configuration = ionoscloud_dbaas_mongo.Configuration(
host = 'https://api.ionos.com/databases/mongodb',
)
# Example of configuring HTTP Basic Authorization
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
with ionoscloud_dbaas_mongo.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = ionoscloud_dbaas_mongo.ClustersApi(api_client)
try:
# Get Clusters
api_response = api_instance.clusters_get()
print(api_response)
except ApiException as e:
print('Exception when calling ClustersApi.clusters_get: %s\n' % e)
Parameters
Name
Type
Description
Notes
limit
int
The maximum number of elements to return. Use together with 'offset' for pagination.
[optional] [default to 100]
offset
int
The first element to return. Use together with 'limit' for pagination.
[optional] [default to 0]
filter_name
str
Response filter to list only the MongoDB clusters that contain the specified name. The value is case insensitive and matched on the 'displayName' field.
from __future__ import print_function
import time
import ionoscloud_dbaas_mongo
from ionoscloud_dbaas_mongo.rest import ApiException
# Defining the host is optional and defaults to https://api.ionos.com/databases/mongodb
configuration = ionoscloud_dbaas_mongo.Configuration(
host = 'https://api.ionos.com/databases/mongodb',
)
# Example of configuring HTTP Basic Authorization
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
with ionoscloud_dbaas_mongo.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = ionoscloud_dbaas_mongo.ClustersApi(api_client)
cluster_id = 'cluster_id_example' # str | The unique ID of the cluster.
patch_cluster_request = ionoscloud_dbaas_mongo.PatchClusterRequest() # PatchClusterRequest | Part of the cluster which should be modified.
try:
# Patch a cluster
api_response = api_instance.clusters_patch(cluster_id, patch_cluster_request)
print(api_response)
except ApiException as e:
print('Exception when calling ClustersApi.clusters_patch: %s\n' % e)
from __future__ import print_function
import time
import ionoscloud_dbaas_mongo
from ionoscloud_dbaas_mongo.rest import ApiException
# Defining the host is optional and defaults to https://api.ionos.com/databases/mongodb
configuration = ionoscloud_dbaas_mongo.Configuration(
host = 'https://api.ionos.com/databases/mongodb',
)
# Example of configuring HTTP Basic Authorization
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
with ionoscloud_dbaas_mongo.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = ionoscloud_dbaas_mongo.ClustersApi(api_client)
create_cluster_request = ionoscloud_dbaas_mongo.CreateClusterRequest() # CreateClusterRequest | The cluster to be created.
try:
# Create a Cluster
api_response = api_instance.clusters_post(create_cluster_request)
print(api_response)
except ApiException as e:
print('Exception when calling ClustersApi.clusters_post: %s\n' % e)
