1. Registry
  2. Packages
  3. Dokploy
  4. API Docs
  5. getMongoDB
Viewing docs for Dokploy v0.4.4
published on Thursday, Nov 5, 2026 by dimeskigj
dokploy logo Dokploy
Viewing docs for Dokploy v0.4.4
published on Thursday, Nov 5, 2026 by dimeskigj

    Read non-secret metadata for an existing Dokploy MongoDB database by ID without managing it.

    Using getMongoDB

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getMongoDB(args: GetMongoDBArgs, opts?: InvokeOptions): Promise<GetMongoDBResult>
    function getMongoDBOutput(args: GetMongoDBOutputArgs, opts?: InvokeOutputOptions): Output<GetMongoDBResult>
    def get_mongo_db(mongo_id: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetMongoDBResult
    def get_mongo_db_output(mongo_id: pulumi.Input[Optional[str]] = None,
                     opts: Optional[InvokeOutputOptions] = None) -> Output[GetMongoDBResult]
    func LookupMongoDB(ctx *Context, args *LookupMongoDBArgs, opts ...InvokeOption) (*LookupMongoDBResult, error)
    func LookupMongoDBOutput(ctx *Context, args *LookupMongoDBOutputArgs, opts ...InvokeOption) LookupMongoDBResultOutput

    > Note: This function is named LookupMongoDB in the Go SDK.

    public static class GetMongoDB 
    {
        public static Task<GetMongoDBResult> InvokeAsync(GetMongoDBArgs args, InvokeOptions? opts = null)
        public static Output<GetMongoDBResult> Invoke(GetMongoDBInvokeArgs args, InvokeOptions? opts = null)
        public static Output<GetMongoDBResult> Invoke(GetMongoDBInvokeArgs args, InvokeOutputOptions opts)
    }
    public static CompletableFuture<GetMongoDBResult> getMongoDB(GetMongoDBArgs args, InvokeOptions options)
    public static Output<GetMongoDBResult> getMongoDB(GetMongoDBArgs args, InvokeOptions options)
    public static Output<GetMongoDBResult> getMongoDB(GetMongoDBArgs args, InvokeOutputOptions options)
    
    fn::invoke:
      function: dokploy:getMongoDB
      arguments:
        # arguments dictionary
    data "dokploy_get_mongo_d_b" "name" {
        # arguments
    }

    The following arguments are supported:

    MongoId string
    The ID of the existing Dokploy MongoDB database to read.
    MongoId string
    The ID of the existing Dokploy MongoDB database to read.
    mongo_id string
    The ID of the existing Dokploy MongoDB database to read.
    mongoId String
    The ID of the existing Dokploy MongoDB database to read.
    mongoId string
    The ID of the existing Dokploy MongoDB database to read.
    mongo_id str
    The ID of the existing Dokploy MongoDB database to read.
    mongoId String
    The ID of the existing Dokploy MongoDB database to read.

    getMongoDB Result

    The following output properties are available:

    MongoId string
    The stable Dokploy MongoDB ID.
    Name string
    The MongoDB database name.
    AppName string
    The optional application name metadata.
    DatabaseUser string
    The optional database username metadata.
    Description string
    The optional description metadata.
    DockerImage string
    The optional Docker image metadata.
    EnvironmentId string
    The optional environment ID metadata.
    ExternalPort int
    The optional external port.
    ReplicaSets bool
    Whether replica sets are enabled, if supplied.
    ServerId string
    The optional server ID metadata.
    Status string
    The optional application status.
    MongoId string
    The stable Dokploy MongoDB ID.
    Name string
    The MongoDB database name.
    AppName string
    The optional application name metadata.
    DatabaseUser string
    The optional database username metadata.
    Description string
    The optional description metadata.
    DockerImage string
    The optional Docker image metadata.
    EnvironmentId string
    The optional environment ID metadata.
    ExternalPort int
    The optional external port.
    ReplicaSets bool
    Whether replica sets are enabled, if supplied.
    ServerId string
    The optional server ID metadata.
    Status string
    The optional application status.
    mongo_id string
    The stable Dokploy MongoDB ID.
    name string
    The MongoDB database name.
    app_name string
    The optional application name metadata.
    database_user string
    The optional database username metadata.
    description string
    The optional description metadata.
    docker_image string
    The optional Docker image metadata.
    environment_id string
    The optional environment ID metadata.
    external_port number
    The optional external port.
    replica_sets bool
    Whether replica sets are enabled, if supplied.
    server_id string
    The optional server ID metadata.
    status string
    The optional application status.
    mongoId String
    The stable Dokploy MongoDB ID.
    name String
    The MongoDB database name.
    appName String
    The optional application name metadata.
    databaseUser String
    The optional database username metadata.
    description String
    The optional description metadata.
    dockerImage String
    The optional Docker image metadata.
    environmentId String
    The optional environment ID metadata.
    externalPort Integer
    The optional external port.
    replicaSets Boolean
    Whether replica sets are enabled, if supplied.
    serverId String
    The optional server ID metadata.
    status String
    The optional application status.
    mongoId string
    The stable Dokploy MongoDB ID.
    name string
    The MongoDB database name.
    appName string
    The optional application name metadata.
    databaseUser string
    The optional database username metadata.
    description string
    The optional description metadata.
    dockerImage string
    The optional Docker image metadata.
    environmentId string
    The optional environment ID metadata.
    externalPort number
    The optional external port.
    replicaSets boolean
    Whether replica sets are enabled, if supplied.
    serverId string
    The optional server ID metadata.
    status string
    The optional application status.
    mongo_id str
    The stable Dokploy MongoDB ID.
    name str
    The MongoDB database name.
    app_name str
    The optional application name metadata.
    database_user str
    The optional database username metadata.
    description str
    The optional description metadata.
    docker_image str
    The optional Docker image metadata.
    environment_id str
    The optional environment ID metadata.
    external_port int
    The optional external port.
    replica_sets bool
    Whether replica sets are enabled, if supplied.
    server_id str
    The optional server ID metadata.
    status str
    The optional application status.
    mongoId String
    The stable Dokploy MongoDB ID.
    name String
    The MongoDB database name.
    appName String
    The optional application name metadata.
    databaseUser String
    The optional database username metadata.
    description String
    The optional description metadata.
    dockerImage String
    The optional Docker image metadata.
    environmentId String
    The optional environment ID metadata.
    externalPort Number
    The optional external port.
    replicaSets Boolean
    Whether replica sets are enabled, if supplied.
    serverId String
    The optional server ID metadata.
    status String
    The optional application status.

    Package Details

    Repository
    dokploy dimeskigj/pulumi-dokploy
    License
    Apache-2.0
    dokploy logo Dokploy
    Viewing docs for Dokploy v0.4.4
    published on Thursday, Nov 5, 2026 by dimeskigj

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial