MongoDB v1 API

The MongoDB v1 API lets you manage MongoDB database clusters programmatically by using the conventional HTTPS requests. The creation of MongoDB cluster functionality that is available in the IONOS Cloud DCD is also available through the API.

What can you do with the MongoDB v1 API?

Use the MongoDB v1 API to:

• Create and configure a MongoDB replica set and sharded clusters.

• Manage database users and access controls.

• Enable the BI Connector for analytics.

• Migrate data between clusters.

• Restore databases from backups.

• Access cluster logs for monitoring and troubleshooting.

MongoDB v1 OpenAPI Specification

Endpoint: https://api.ionos.com/databases/mongodb

To make authenticated requests to the API, you need to include a few fields in the request headers. The following are the relevant request parameters and descriptions:

Request parameter headers

Header	Required	Type	Description
Authorization	yes	string	HTTP Basic authorization. A base64 encoded string of a username and password separated by a colon. [email protected]:password
X-Contract-Number	no	integer	Users with more than one contract may apply this header to indicate which contract it applies to.
Content-Type	yes	string	Set this to application/json.

Examples

We use curl in our examples because it is available on Windows 10, Linux and macOS. If you encounter any problems with curl on Linux or Windows, refer to the following:

Linux cURL - How to use the Curl Command in LinuxIONOS Digital Guide

Getting started with cURL in WindowsIONOS Digital Guide

Quick Links

Create a MongoDB Cluster

Learn how to create a MongoDB cluster.

Create a Sharded Database Cluster

Learn how to create a MongoDB sharded cluster.

Modify Cluster Attributes

Learn how to modify a MongoDB cluster attributes.

Enable the BI Connector

Learn how to enable the BI Connector.

Users Management

Learn how to create, view, and delete users using MongoDB clusters.

Access Logs

Learn how to access the logs via the API.

Database Migration

Learn how to migrate your MongoDB data from one cluster to another one.

Restore a Database

Learn how to restore a database cluster.

Connect from Kubernetes

Learn how to connect to a MongoDB cluster from your managed Kubernetes cluster.

Connect to a MongoDB Instance

Learn how to connect to a MongoDB instance with the MongoDB Shell `mongosh`.