> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.itential.com/adapters/configure/service-instance-configuration/properties/mongo-properties/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.itential.com/_mcp/server.

# Mongo properties

> Reference for the adapter mongo object properties that configure a database for storing metrics, throttle queue state, and adapter configuration.

All MongoDB properties are defined within the `mongo` object in theItential Platform service instance configuration for the adapter. The adapter uses MongoDB to store three things: metrics, the throttle queue, and optionally the adapter configuration.

MongoDB is not required for the adapter to function. If you do not configure it, you can disable metrics or store them on the file system, and throttling can operate in memory.

Do not store adapter database information in theItential Platform database. Doing so can cause issues when upgradingItential Platform.

## Properties

| Property   | Type    | Required | Description                                                                                                                                                                                                                                    |
| ---------- | ------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `host`     | string  | No       | Hostname of the MongoDB server.                                                                                                                                                                                                                |
| `port`     | integer | No       | Port on the MongoDB server.                                                                                                                                                                                                                    |
| `database` | string  | No       | Name of the adapter database within the MongoDB instance.                                                                                                                                                                                      |
| `username` | string  | No       | Username for authenticating with the database.                                                                                                                                                                                                 |
| `password` | string  | No       | Password for authenticating with the database.                                                                                                                                                                                                 |
| `replSet`  | string  | No       | Replica set name, if a replica set is in use.                                                                                                                                                                                                  |
| `db_ssl`   | object  | No       | SSL configuration for the database connection. Fields: `enabled` (boolean), `accept_invalid_certs` (boolean), `ca_file` (string, fully qualified path), `key_file` (string, fully qualified path), `cert_file` (string, fully qualified path). |

## Example

This example connects to a MongoDB instance at `mymongo.com:27017` using username and password authentication, without a replica set or SSL.

```json
"mongo": {
  "host": "mymongo.com",
  "port": 27017,
  "database": "adapter-xyz",
  "username": "username",
  "password": "password",
  "replSet": "",
  "db_ssl": {
    "enabled": false,
    "accept_invalid_cert": true,
    "ca_file": "",
    "key_file": "",
    "cert_file": ""
  }
}
```

> Reference for the adapter mongo object properties that configure a database for storing metrics, throttle queue state, and adapter configuration.