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

    Using getRedis

    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 getRedis(args: GetRedisArgs, opts?: InvokeOptions): Promise<GetRedisResult>
    function getRedisOutput(args: GetRedisOutputArgs, opts?: InvokeOutputOptions): Output<GetRedisResult>
    def get_redis(redis_id: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetRedisResult
    def get_redis_output(redis_id: pulumi.Input[Optional[str]] = None,
                  opts: Optional[InvokeOutputOptions] = None) -> Output[GetRedisResult]
    func LookupRedis(ctx *Context, args *LookupRedisArgs, opts ...InvokeOption) (*LookupRedisResult, error)
    func LookupRedisOutput(ctx *Context, args *LookupRedisOutputArgs, opts ...InvokeOption) LookupRedisResultOutput

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

    public static class GetRedis 
    {
        public static Task<GetRedisResult> InvokeAsync(GetRedisArgs args, InvokeOptions? opts = null)
        public static Output<GetRedisResult> Invoke(GetRedisInvokeArgs args, InvokeOptions? opts = null)
        public static Output<GetRedisResult> Invoke(GetRedisInvokeArgs args, InvokeOutputOptions opts)
    }
    public static CompletableFuture<GetRedisResult> getRedis(GetRedisArgs args, InvokeOptions options)
    public static Output<GetRedisResult> getRedis(GetRedisArgs args, InvokeOptions options)
    public static Output<GetRedisResult> getRedis(GetRedisArgs args, InvokeOutputOptions options)
    
    fn::invoke:
      function: dokploy:getRedis
      arguments:
        # arguments dictionary
    data "dokploy_get_redis" "name" {
        # arguments
    }

    The following arguments are supported:

    RedisId string
    The ID of the existing Dokploy Redis database to read.
    RedisId string
    The ID of the existing Dokploy Redis database to read.
    redis_id string
    The ID of the existing Dokploy Redis database to read.
    redisId String
    The ID of the existing Dokploy Redis database to read.
    redisId string
    The ID of the existing Dokploy Redis database to read.
    redis_id str
    The ID of the existing Dokploy Redis database to read.
    redisId String
    The ID of the existing Dokploy Redis database to read.

    getRedis Result

    The following output properties are available:

    Name string
    The Redis database name.
    RedisId string
    The stable Dokploy Redis ID.
    AppName string
    The optional application name 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 Redis database name.
    RedisId string
    The stable Dokploy Redis ID.
    AppName string
    The optional application name 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 Redis database name.
    redis_id string
    The stable Dokploy Redis ID.
    app_name string
    The optional application name 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 Redis database name.
    redisId String
    The stable Dokploy Redis ID.
    appName String
    The optional application name 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 Redis database name.
    redisId string
    The stable Dokploy Redis ID.
    appName string
    The optional application name 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 Redis database name.
    redis_id str
    The stable Dokploy Redis ID.
    app_name str
    The optional application name 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 Redis database name.
    redisId String
    The stable Dokploy Redis ID.
    appName String
    The optional application name 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