CONFIG GET - Upstash Documentation

Use CONFIG GET to read runtime configuration parameters.

Parameter names may contain glob-style patterns, so one call can fetch a family of settings. The reply is a map of names to values under RESP3, and the same pairs as a flat array under RESP2.

This deployment exposes only notify-keyspace-events, which controls the keyspace notifications published on pub/sub. Other names simply return no matching entries rather than an error, so check the reply for the parameter you asked about instead of assuming it was present.

Syntax#

CONFIG GET <parameter> [parameter ...]

Arguments#

Argument	Required	Repeatable	Description
`parameter`	Yes	Yes	One or more glob-style configuration parameter patterns.

Important points#

This command can expose administrative information or make a broad destructive change. Restrict it to trusted code paths.
This deployment exposes only notify-keyspace-events. Other patterns return no matching entries.
Both RESP2 and RESP3 return a flat array of alternating parameter names and values.

Response#

The reply reports the result of the operation. Error replies have the same shape in RESP2 and RESP3 and are surfaced as exceptions by the SDKs below.

Protocol	Reply
RESP2	Flat array of alternating configuration names and values
RESP3	Map of configuration names to values

Note

Client libraries often decode bulk strings, maps, sets, and numeric strings into language-native values. The table describes the Redis wire reply.

Examples#

TCP examples use the TLS REDIS_URL from the Upstash console. REST examples use UPSTASH_REDIS_REST_URL and UPSTASH_REDIS_REST_TOKEN.

Redis CLI

CONFIG GET notify-keyspace-events

@upstash/redis

Note

This command is not supported yet in @upstash/redis.

upstash_redis

Note

This command is not supported yet in upstash_redis.

ioredis

import Redis from "ioredis";const redis = new Redis(process.env.REDIS_URL!);const result = await redis.config("GET", "notify-keyspace-events");console.log(result);

node-redis

import { createClient } from "redis";const client = await createClient({ url: process.env.REDIS_URL })  .on("error", console.error)  .connect();const result = await client.configGet("notify-keyspace-events");console.log(result);

redis-py

import osimport redisclient = redis.from_url(os.environ["REDIS_URL"])result = client.config_get("notify-keyspace-events")print(result)

go-redis

package mainimport (    "context"    "fmt"    "os"    "github.com/redis/go-redis/v9")func main() {    opts, err := redis.ParseURL(os.Getenv("REDIS_URL"))    if err != nil {        panic(err)    }    client := redis.NewClient(opts)    result, err := client.ConfigGet(context.Background(), "notify-keyspace-events").Result()    if err != nil {        panic(err)    }    fmt.Println(result)}

jedis

import java.net.URI;import redis.clients.jedis.Jedis;try (Jedis jedis = new Jedis(new URI(System.getenv("REDIS_URL")))) {  Object result = jedis.configGet("notify-keyspace-events");  System.out.println(result);}

redis-rs

fn main() -> redis::RedisResult<()> {    let url = std::env::var("REDIS_URL").expect("REDIS_URL is not set");    let client = redis::Client::open(url)?;    let mut connection = client.get_connection()?;    let mut command = redis::cmd("CONFIG");    command.arg("GET");    command.arg("notify-keyspace-events");    let result: redis::Value = command.query(&mut connection)?;    println!("{result:?}");    Ok(())}