AptlyStar

Upstash

Serverless Redis with Upstash

Instrucciones de uso

Connect to Upstash Redis to perform key-value, hash, list, and utility operations via the REST API.

Herramientas

upstash_redis_get

Get the value of a key from Upstash Redis.

Entrada

ParámetroTipoObligatorioDescripción
restUrlstringSíUpstash Redis REST URL
restTokenstringSíUpstash Redis REST Token
keystringSíThe key to retrieve

Salida

ParámetroTipoDescripción
keystringThe key that was retrieved
valuejsonThe value of the key (string), or null if not found

upstash_redis_set

Set the value of a key in Upstash Redis with an optional expiration time in seconds.

Entrada

ParámetroTipoObligatorioDescripción
restUrlstringSíUpstash Redis REST URL
restTokenstringSíUpstash Redis REST Token
keystringSíThe key to set
valuestringSíThe value to store
exnumberNoExpiration time in seconds (optional)

Salida

ParámetroTipoDescripción
keystringThe key that was set
resultstringThe result of the SET operation (typically "OK")

upstash_redis_delete

Delete a key from Upstash Redis.

Entrada

ParámetroTipoObligatorioDescripción
restUrlstringSíUpstash Redis REST URL
restTokenstringSíUpstash Redis REST Token
keystringSíThe key to delete

Salida

ParámetroTipoDescripción
keystringThe key that was deleted
deletedCountnumberNumber of keys deleted (0 if key did not exist, 1 if deleted)

upstash_redis_keys

List keys matching a pattern in Upstash Redis. Defaults to listing all keys (*).

Entrada

ParámetroTipoObligatorioDescripción
restUrlstringSíUpstash Redis REST URL
restTokenstringSíUpstash Redis REST Token
patternstringNoPattern to match keys (e.g., "user:"). Defaults to "" for all keys.

Salida

ParámetroTipoDescripción
patternstringThe pattern used to match keys
keysarrayList of keys matching the pattern
countnumberNumber of keys found

upstash_redis_command

Execute an arbitrary Redis command against Upstash Redis. Pass the full command as a JSON array (e.g., [

Entrada

ParámetroTipoObligatorioDescripción
restUrlstringSíUpstash Redis REST URL
restTokenstringSíUpstash Redis REST Token
commandstringSíRedis command as a JSON array (e.g., ["HSET", "myhash", "field1", "value1"]) or a simple command string (e.g., "PING")

Salida

ParámetroTipoDescripción
commandstringThe command that was executed
resultjsonThe result of the Redis command

upstash_redis_hset

Set a field in a hash stored at a key in Upstash Redis.

Entrada

ParámetroTipoObligatorioDescripción
restUrlstringSíUpstash Redis REST URL
restTokenstringSíUpstash Redis REST Token
keystringSíThe hash key
fieldstringSíThe field name within the hash
valuestringSíThe value to store in the hash field

Salida

ParámetroTipoDescripción
keystringThe hash key
fieldstringThe field that was set
resultnumberNumber of new fields added (0 if field was updated, 1 if new)

upstash_redis_hget

Get the value of a field in a hash stored at a key in Upstash Redis.

Entrada

ParámetroTipoObligatorioDescripción
restUrlstringSíUpstash Redis REST URL
restTokenstringSíUpstash Redis REST Token
keystringSíThe hash key
fieldstringSíThe field name to retrieve

Salida

ParámetroTipoDescripción
keystringThe hash key
fieldstringThe field that was retrieved
valuejsonThe value of the hash field (string), or null if not found

upstash_redis_hgetall

Get all fields and values of a hash stored at a key in Upstash Redis.

Entrada

ParámetroTipoObligatorioDescripción
restUrlstringSíUpstash Redis REST URL
restTokenstringSíUpstash Redis REST Token
keystringSíThe hash key

Salida

ParámetroTipoDescripción
keystringThe hash key
fieldsobjectAll field-value pairs in the hash, keyed by field name
fieldCountnumberNumber of fields in the hash

upstash_redis_incr

Atomically increment the integer value of a key by one in Upstash Redis. If the key does not exist, it is set to 0 before incrementing.

Entrada

ParámetroTipoObligatorioDescripción
restUrlstringSíUpstash Redis REST URL
restTokenstringSíUpstash Redis REST Token
keystringSíThe key to increment

Salida

ParámetroTipoDescripción
keystringThe key that was incremented
valuenumberThe new value after incrementing

upstash_redis_expire

Set a timeout on a key in Upstash Redis. After the timeout, the key is deleted.

Entrada

ParámetroTipoObligatorioDescripción
restUrlstringSíUpstash Redis REST URL
restTokenstringSíUpstash Redis REST Token
keystringSíThe key to set expiration on
secondsnumberSíTimeout in seconds

Salida

ParámetroTipoDescripción
keystringThe key that expiration was set on
resultnumber1 if the timeout was set, 0 if the key does not exist

upstash_redis_ttl

Get the remaining time to live of a key in Upstash Redis. Returns -1 if the key has no expiration, -2 if the key does not exist.

Entrada

ParámetroTipoObligatorioDescripción
restUrlstringSíUpstash Redis REST URL
restTokenstringSíUpstash Redis REST Token
keystringSíThe key to check TTL for

Salida

ParámetroTipoDescripción
keystringThe key checked
ttlnumberRemaining TTL in seconds. Positive integer if the key has a TTL set, -1 if the key exists with no expiration, -2 if the key does not exist.

upstash_redis_lpush

Prepend a value to the beginning of a list in Upstash Redis. Creates the list if it does not exist.

Entrada

ParámetroTipoObligatorioDescripción
restUrlstringSíUpstash Redis REST URL
restTokenstringSíUpstash Redis REST Token
keystringSíThe list key
valuestringSíThe value to prepend to the list

Salida

ParámetroTipoDescripción
keystringThe list key
lengthnumberThe length of the list after the push

upstash_redis_lrange

Get a range of elements from a list in Upstash Redis. Use 0 and -1 for start and stop to get all elements.

Entrada

ParámetroTipoObligatorioDescripción
restUrlstringSíUpstash Redis REST URL
restTokenstringSíUpstash Redis REST Token
keystringSíThe list key
startnumberSíStart index (0-based, negative values count from end)
stopnumberSíStop index (inclusive, -1 for last element)

Salida

ParámetroTipoDescripción
keystringThe list key
valuesarrayList of elements in the specified range
countnumberNumber of elements returned

upstash_redis_exists

Check if a key exists in Upstash Redis. Returns true if the key exists, false otherwise.

Entrada

ParámetroTipoObligatorioDescripción
restUrlstringSíUpstash Redis REST URL
restTokenstringSíUpstash Redis REST Token
keystringSíThe key to check

Salida

ParámetroTipoDescripción
keystringThe key that was checked
existsbooleanWhether the key exists (true) or not (false)

upstash_redis_setnx

Set the value of a key only if it does not already exist. Returns true if the key was set, false if it already existed.

Entrada

ParámetroTipoObligatorioDescripción
restUrlstringSíUpstash Redis REST URL
restTokenstringSíUpstash Redis REST Token
keystringSíThe key to set
valuestringSíThe value to store if the key does not exist

Salida

ParámetroTipoDescripción
keystringThe key that was attempted to set
wasSetbooleanWhether the key was set (true) or already existed (false)

upstash_redis_incrby

Increment the integer value of a key by a given amount. Use a negative value to decrement. If the key does not exist, it is set to 0 before the operation.

Entrada

ParámetroTipoObligatorioDescripción
restUrlstringSíUpstash Redis REST URL
restTokenstringSíUpstash Redis REST Token
keystringSíThe key to increment
incrementnumberSíAmount to increment by (use negative value to decrement)

Salida

ParámetroTipoDescripción
keystringThe key that was incremented
valuenumberThe new value after incrementing

On this page