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
clusters_delete(cluster_id)
Delete a Cluster
Deletes a MongoDB cluster.
Examples
require 'time'
require 'ionoscloud-dbaas-mongo'
# setup authorization
IonoscloudDbaasMongo.configure do |config|
# Configure HTTP basic authorization: basicAuth
config.username = 'YOUR USERNAME'
config.password = 'YOUR PASSWORD'
# Configure API key authorization: tokenAuth
config.api_key['Authorization'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
# config.api_key_prefix['Authorization'] = 'Bearer'
end
api_instance = IonoscloudDbaasMongo::ClustersApi.new
cluster_id = 'cluster_id_example' # String | The unique ID of the cluster.
begin
# Delete a Cluster
result = api_instance.clusters_delete(cluster_id)
p result
rescue IonoscloudDbaasMongo::ApiError => e
puts "Error when calling ClustersApi->clusters_delete: #{e}"
end
Using the clusters_delete_with_http_info variant
This returns an Array which contains the response data, status code and headers.
begin
# Delete a Cluster
data, status_code, headers = api_instance.clusters_delete_with_http_info(cluster_id)
p status_code # => 2xx
p headers # => { ... }
p data # => <ClusterResponse>
rescue IonoscloudDbaasMongo::ApiError => e
puts "Error when calling ClustersApi->clusters_delete_with_http_info: #{e}"
end
require 'time'
require 'ionoscloud-dbaas-mongo'
# setup authorization
IonoscloudDbaasMongo.configure do |config|
# Configure HTTP basic authorization: basicAuth
config.username = 'YOUR USERNAME'
config.password = 'YOUR PASSWORD'
# Configure API key authorization: tokenAuth
config.api_key['Authorization'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
# config.api_key_prefix['Authorization'] = 'Bearer'
end
api_instance = IonoscloudDbaasMongo::ClustersApi.new
cluster_id = 'cluster_id_example' # String | The unique ID of the cluster.
begin
# Get a cluster by id
result = api_instance.clusters_find_by_id(cluster_id)
p result
rescue IonoscloudDbaasMongo::ApiError => e
puts "Error when calling ClustersApi->clusters_find_by_id: #{e}"
end
Using the clusters_find_by_id_with_http_info variant
This returns an Array which contains the response data, status code and headers.
begin
# Get a cluster by id
data, status_code, headers = api_instance.clusters_find_by_id_with_http_info(cluster_id)
p status_code # => 2xx
p headers # => { ... }
p data # => <ClusterResponse>
rescue IonoscloudDbaasMongo::ApiError => e
puts "Error when calling ClustersApi->clusters_find_by_id_with_http_info: #{e}"
end
require 'time'
require 'ionoscloud-dbaas-mongo'
# setup authorization
IonoscloudDbaasMongo.configure do |config|
# Configure HTTP basic authorization: basicAuth
config.username = 'YOUR USERNAME'
config.password = 'YOUR PASSWORD'
# Configure API key authorization: tokenAuth
config.api_key['Authorization'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
# config.api_key_prefix['Authorization'] = 'Bearer'
end
api_instance = IonoscloudDbaasMongo::ClustersApi.new
opts = {
limit: 100, # Integer | The maximum number of elements to return. Use together with 'offset' for pagination.
offset: 200, # Integer | The first element to return. Use together with 'limit' for pagination.
filter_name: 'filter_name_example' # String | Response filter to list only the MongoDB clusters that contain the specified name. The value is case insensitive and matched on the 'displayName' field.
}
begin
# Get Clusters
result = api_instance.clusters_get(opts)
p result
rescue IonoscloudDbaasMongo::ApiError => e
puts "Error when calling ClustersApi->clusters_get: #{e}"
end
Using the clusters_get_with_http_info variant
This returns an Array which contains the response data, status code and headers.
begin
# Get Clusters
data, status_code, headers = api_instance.clusters_get_with_http_info(opts)
p status_code # => 2xx
p headers # => { ... }
p data # => <ClusterList>
rescue IonoscloudDbaasMongo::ApiError => e
puts "Error when calling ClustersApi->clusters_get_with_http_info: #{e}"
end
Parameters
Name
Type
Description
Notes
limit
Integer
The maximum number of elements to return. Use together with 'offset' for pagination.
[optional][default to 100]
offset
Integer
The first element to return. Use together with 'limit' for pagination.
[optional][default to 0]
filter_name
String
Response filter to list only the MongoDB clusters that contain the specified name. The value is case insensitive and matched on the 'displayName' field.
require 'time'
require 'ionoscloud-dbaas-mongo'
# setup authorization
IonoscloudDbaasMongo.configure do |config|
# Configure HTTP basic authorization: basicAuth
config.username = 'YOUR USERNAME'
config.password = 'YOUR PASSWORD'
# Configure API key authorization: tokenAuth
config.api_key['Authorization'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
# config.api_key_prefix['Authorization'] = 'Bearer'
end
api_instance = IonoscloudDbaasMongo::ClustersApi.new
cluster_id = 'cluster_id_example' # String | The unique ID of the cluster.
patch_cluster_request = IonoscloudDbaasMongo::PatchClusterRequest.new # PatchClusterRequest | Part of the cluster which should be modified.
begin
# Patch a cluster
result = api_instance.clusters_patch(cluster_id, patch_cluster_request)
p result
rescue IonoscloudDbaasMongo::ApiError => e
puts "Error when calling ClustersApi->clusters_patch: #{e}"
end
Using the clusters_patch_with_http_info variant
This returns an Array which contains the response data, status code and headers.
begin
# Patch a cluster
data, status_code, headers = api_instance.clusters_patch_with_http_info(cluster_id, patch_cluster_request)
p status_code # => 2xx
p headers # => { ... }
p data # => <ClusterResponse>
rescue IonoscloudDbaasMongo::ApiError => e
puts "Error when calling ClustersApi->clusters_patch_with_http_info: #{e}"
end
require 'time'
require 'ionoscloud-dbaas-mongo'
# setup authorization
IonoscloudDbaasMongo.configure do |config|
# Configure HTTP basic authorization: basicAuth
config.username = 'YOUR USERNAME'
config.password = 'YOUR PASSWORD'
# Configure API key authorization: tokenAuth
config.api_key['Authorization'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
# config.api_key_prefix['Authorization'] = 'Bearer'
end
api_instance = IonoscloudDbaasMongo::ClustersApi.new
create_cluster_request = IonoscloudDbaasMongo::CreateClusterRequest.new # CreateClusterRequest | The cluster to be created.
begin
# Create a Cluster
result = api_instance.clusters_post(create_cluster_request)
p result
rescue IonoscloudDbaasMongo::ApiError => e
puts "Error when calling ClustersApi->clusters_post: #{e}"
end
Using the clusters_post_with_http_info variant
This returns an Array which contains the response data, status code and headers.
begin
# Create a Cluster
data, status_code, headers = api_instance.clusters_post_with_http_info(create_cluster_request)
p status_code # => 2xx
p headers # => { ... }
p data # => <ClusterResponse>
rescue IonoscloudDbaasMongo::ApiError => e
puts "Error when calling ClustersApi->clusters_post_with_http_info: #{e}"
end
