Skip to main content
Properties for MongoDB connections are specified in the properties object when creating or updating a connection. All properties are nested within the connection request body.

​
Properties

​
protocol
string
required
MongoDB connection protocol. Use mongodb for standard connections or mongodb+srv for connections using DNS seed list format (typically used with MongoDB Atlas).
​
host
string
required
MongoDB server hostname or fully qualified domain name.
​
username
string
required
Username for authenticating to the MongoDB server.
​
password
object
required
Reference to a Prophecy secret containing the MongoDB password.
  • When using the create connection API, the secret must be stored in Prophecy before creating the connection.
  • When using the create fabric API, replace this whole object with the string {{SECRET}}, which references the secret being created in parallel to the connection.
​
database
string
required
Name of the MongoDB database where Prophecy will write data by default.
​
collection
string
required
Name of the collection where Prophecy will write data by default.