ClustersApi
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 |
clustersDelete
clustersDelete(clusterId)
Delete a Cluster
Deletes a MongoDB cluster.
Examples
Parameters
Name | Type | Description | Notes |
---|---|---|---|
clusterId | string | The unique ID of the cluster. | [default to undefined] |
Return type
Authorization
basicAuth, tokenAuth
HTTP request headers
Content-Type: Not defined
Accept: application/json
clustersFindById
clustersFindById(clusterId)
Get a cluster by id
Get a cluster by id.
Examples
Parameters
Name | Type | Description | Notes |
---|---|---|---|
clusterId | string | The unique ID of the cluster. | [default to undefined] |
Return type
Authorization
basicAuth, tokenAuth
HTTP request headers
Content-Type: Not defined
Accept: application/json
clustersGet
clustersGet(opts)
Get Clusters
Retrieves a list of MongoDB clusters.
Examples
Parameters
Name | Type | Description | Notes |
---|---|---|---|
limit | number | The maximum number of elements to return. Use together with 'offset' for pagination. | [optional][default to 100] |
offset | number | The first element to return. Use together with 'limit' for pagination. | [optional][default to 0] |
filterName | 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. | [optional][default to undefined] |
Return type
Authorization
basicAuth, tokenAuth
HTTP request headers
Content-Type: Not defined
Accept: application/json
clustersPatch
clustersPatch(clusterId, patchClusterRequest)
Patch a cluster
Patch attributes of a MongoDB cluster.
Examples
Parameters
Name | Type | Description | Notes |
---|---|---|---|
clusterId | string | The unique ID of the cluster. | [default to undefined] |
patchClusterRequest | Part of the cluster which should be modified. |
Return type
Authorization
basicAuth, tokenAuth
HTTP request headers
Content-Type: application/json
Accept: application/json
clustersPost
clustersPost(createClusterRequest)
Create a Cluster
Creates a new MongoDB cluster.
Examples
Parameters
Name | Type | Description | Notes |
---|---|---|---|
createClusterRequest | The cluster to be created. |
Return type
Authorization
basicAuth, tokenAuth
HTTP request headers
Content-Type: application/json
Accept: application/json
Last updated