1. Registry
  2. Packages
  3. Dokploy
  4. API Docs
  5. getPostgres
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 Postgres database by ID without managing it.

    Using getPostgres

    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 getPostgres(args: GetPostgresArgs, opts?: InvokeOptions): Promise<GetPostgresResult>
    function getPostgresOutput(args: GetPostgresOutputArgs, opts?: InvokeOutputOptions): Output<GetPostgresResult>
    def get_postgres(postgres_id: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetPostgresResult
    def get_postgres_output(postgres_id: pulumi.Input[Optional[str]] = None,
                     opts: Optional[InvokeOutputOptions] = None) -> Output[GetPostgresResult]
    func LookupPostgres(ctx *Context, args *LookupPostgresArgs, opts ...InvokeOption) (*LookupPostgresResult, error)
    func LookupPostgresOutput(ctx *Context, args *LookupPostgresOutputArgs, opts ...InvokeOption) LookupPostgresResultOutput

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

    public static class GetPostgres 
    {
        public static Task<GetPostgresResult> InvokeAsync(GetPostgresArgs args, InvokeOptions? opts = null)
        public static Output<GetPostgresResult> Invoke(GetPostgresInvokeArgs args, InvokeOptions? opts = null)
        public static Output<GetPostgresResult> Invoke(GetPostgresInvokeArgs args, InvokeOutputOptions opts)
    }
    public static CompletableFuture<GetPostgresResult> getPostgres(GetPostgresArgs args, InvokeOptions options)
    public static Output<GetPostgresResult> getPostgres(GetPostgresArgs args, InvokeOptions options)
    public static Output<GetPostgresResult> getPostgres(GetPostgresArgs args, InvokeOutputOptions options)
    
    fn::invoke:
      function: dokploy:getPostgres
      arguments:
        # arguments dictionary
    data "dokploy_get_postgres" "name" {
        # arguments
    }

    The following arguments are supported:

    PostgresId string
    The ID of the existing Dokploy Postgres database to read.
    PostgresId string
    The ID of the existing Dokploy Postgres database to read.
    postgres_id string
    The ID of the existing Dokploy Postgres database to read.
    postgresId String
    The ID of the existing Dokploy Postgres database to read.
    postgresId string
    The ID of the existing Dokploy Postgres database to read.
    postgres_id str
    The ID of the existing Dokploy Postgres database to read.
    postgresId String
    The ID of the existing Dokploy Postgres database to read.

    getPostgres Result

    The following output properties are available:

    Name string
    The Postgres database name.
    PostgresId string
    The stable Dokploy Postgres ID.
    AppName string
    The optional application name metadata.
    DatabaseName string
    The optional database 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.
    ServerId string
    The optional server ID metadata.
    Status string
    The optional application status.
    Name string
    The Postgres database name.
    PostgresId string
    The stable Dokploy Postgres ID.
    AppName string
    The optional application name metadata.
    DatabaseName string
    The optional database 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.
    ServerId string
    The optional server ID metadata.
    Status string
    The optional application status.
    name string
    The Postgres database name.
    postgres_id string
    The stable Dokploy Postgres ID.
    app_name string
    The optional application name metadata.
    database_name string
    The optional database 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.
    server_id string
    The optional server ID metadata.
    status string
    The optional application status.
    name String
    The Postgres database name.
    postgresId String
    The stable Dokploy Postgres ID.
    appName String
    The optional application name metadata.
    databaseName String
    The optional database 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.
    serverId String
    The optional server ID metadata.
    status String
    The optional application status.
    name string
    The Postgres database name.
    postgresId string
    The stable Dokploy Postgres ID.
    appName string
    The optional application name metadata.
    databaseName string
    The optional database 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.
    serverId string
    The optional server ID metadata.
    status string
    The optional application status.
    name str
    The Postgres database name.
    postgres_id str
    The stable Dokploy Postgres ID.
    app_name str
    The optional application name metadata.
    database_name str
    The optional database 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.
    server_id str
    The optional server ID metadata.
    status str
    The optional application status.
    name String
    The Postgres database name.
    postgresId String
    The stable Dokploy Postgres ID.
    appName String
    The optional application name metadata.
    databaseName String
    The optional database 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.
    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