> For the complete documentation index, see [llms.txt](https://docs.ionos.com/cloud/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.ionos.com/cloud/ruby/dbaas-mongodb/readme.md).

# Introduction

IonoscloudDbaasMongo - the Ruby gem for the IONOS DBaaS MongoDB REST API

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.

This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

* API version: 0.1.0
* Package version: 1.0.0
* Build package: org.openapitools.codegen.languages.RubyClientCodegen

## Installation

### Build a gem

To build the Ruby code into a gem:

```shell
gem build ionoscloud-dbaas-mongo.gemspec
```

Then either install the gem locally:

```shell
gem install ./ionoscloud-dbaas-mongo-1.0.0.gem
```

(for development, run `gem install --dev ./ionoscloud-dbaas-mongo-1.0.0.gem` to install the development dependencies)

or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).

Finally add this to the Gemfile:

```
gem 'ionoscloud-dbaas-mongo', '~> 1.0.0'
```

### Install from Git

If the Ruby gem is hosted at a git repository: <https://github.com/ionos-cloud/sdk-ruby-dbaas-mongo>, then add the following in the Gemfile:

```
gem 'ionoscloud-dbaas-mongo', :git => 'https://github.com/ionos-cloud/sdk-ruby-dbaas-mongo.git'
```

### Include the Ruby code directly

Include the Ruby code directly using `-I` as follows:

```shell
ruby -Ilib script.rb
```

## Our latest, most up to date documentation is available [here](https://github.com/ionos-cloud/sdk-ruby/blob/master/README.md)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.ionos.com/cloud/ruby/dbaas-mongodb/readme.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.