Get Started on Cloud
BasicsAI AgentsPipelinesActions & ServicesEnvironmentsIntegrationsTargetsTestsDomainsSandboxesAgents & TunnelsYAMLBuddy GitCLIAPIFAQ

YAML for MongoDB

View as Markdown

MongoDB target for executing queries on a MongoDB database.

YAML parameters for MongoDB

PARAMETERS
hostrequiredstring
The hostname or IP address of the MongoDB server
targetrequiredstring
The human-readable ID of the target
namestring
The name of the target
portstring
The port of the MongoDB server. Default: 27017
databasestring
The default database name
auth_sourcestring
The authentication database (e.g. admin). If not set, the target database is used
authMongoAuthYaml
MongoDB authentication credentials
proxystring
SSH proxy target for tunneling to private MongoDB servers
permissionsPermissionsYaml
Access permissions for the target
disabledboolean
Indicates if this target is disabled (default: false)
tagsstring[]
The list of tags associated with the target
use_asUseAsYaml
Defines how the target can be used (as deployment target, proxy, or both)
notestring
Note for this resource
agent_notestring
YAML note for AI agents operating on this resource
typestring

Value: MONGO

Last modified on Sep 17, 2026

Previous pageMicrosoft SQL ServerNext pageMySQL

YAML examples for MongoDB

MongoDB target with a separate authentication database

yaml
- target: production_mongo
  type: MONGO
  name: Production MongoDB
  host: mongo.example.com
  port: "27017"
  database: myapp
  auth_source: admin
  auth:
    username: deploy_user
    password: $password
  proxy: my_ssh_bastion
  tags:
    - mongodb

Minimal

yaml
- target: production_mongo
  type: MONGO
  host: mongo.example.com
  auth:
    username: deploy_user
    password: $password