AptlyStar

Upstash

Serverless Redis with Upstash

Instructions d'utilisation

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

Outils

upstash_redis_get

Get the value of a key from Upstash Redis.

Entrée

ParamètreTypeObligatoireDescription
restUrlstringOuiUpstash Redis REST URL
restTokenstringOuiUpstash Redis REST Token
keystringOuiThe key to retrieve

Sortie

ParamètreTypeDescription
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.

Entrée

ParamètreTypeObligatoireDescription
restUrlstringOuiUpstash Redis REST URL
restTokenstringOuiUpstash Redis REST Token
keystringOuiThe key to set
valuestringOuiThe value to store
exnumberNonExpiration time in seconds (optional)

Sortie

ParamètreTypeDescription
keystringThe key that was set
resultstringThe result of the SET operation (typically "OK")

upstash_redis_delete

Delete a key from Upstash Redis.

Entrée

ParamètreTypeObligatoireDescription
restUrlstringOuiUpstash Redis REST URL
restTokenstringOuiUpstash Redis REST Token
keystringOuiThe key to delete

Sortie

ParamètreTypeDescription
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 (*).

Entrée

ParamètreTypeObligatoireDescription
restUrlstringOuiUpstash Redis REST URL
restTokenstringOuiUpstash Redis REST Token
patternstringNonPattern to match keys (e.g., "user:"). Defaults to "" for all keys.

Sortie

ParamètreTypeDescription
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., [

Entrée

ParamètreTypeObligatoireDescription
restUrlstringOuiUpstash Redis REST URL
restTokenstringOuiUpstash Redis REST Token
commandstringOuiRedis command as a JSON array (e.g., ["HSET", "myhash", "field1", "value1"]) or a simple command string (e.g., "PING")

Sortie

ParamètreTypeDescription
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.

Entrée

ParamètreTypeObligatoireDescription
restUrlstringOuiUpstash Redis REST URL
restTokenstringOuiUpstash Redis REST Token
keystringOuiThe hash key
fieldstringOuiThe field name within the hash
valuestringOuiThe value to store in the hash field

Sortie

ParamètreTypeDescription
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.

Entrée

ParamètreTypeObligatoireDescription
restUrlstringOuiUpstash Redis REST URL
restTokenstringOuiUpstash Redis REST Token
keystringOuiThe hash key
fieldstringOuiThe field name to retrieve

Sortie

ParamètreTypeDescription
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.

Entrée

ParamètreTypeObligatoireDescription
restUrlstringOuiUpstash Redis REST URL
restTokenstringOuiUpstash Redis REST Token
keystringOuiThe hash key

Sortie

ParamètreTypeDescription
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.

Entrée

ParamètreTypeObligatoireDescription
restUrlstringOuiUpstash Redis REST URL
restTokenstringOuiUpstash Redis REST Token
keystringOuiThe key to increment

Sortie

ParamètreTypeDescription
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.

Entrée

ParamètreTypeObligatoireDescription
restUrlstringOuiUpstash Redis REST URL
restTokenstringOuiUpstash Redis REST Token
keystringOuiThe key to set expiration on
secondsnumberOuiTimeout in seconds

Sortie

ParamètreTypeDescription
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.

Entrée

ParamètreTypeObligatoireDescription
restUrlstringOuiUpstash Redis REST URL
restTokenstringOuiUpstash Redis REST Token
keystringOuiThe key to check TTL for

Sortie

ParamètreTypeDescription
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.

Entrée

ParamètreTypeObligatoireDescription
restUrlstringOuiUpstash Redis REST URL
restTokenstringOuiUpstash Redis REST Token
keystringOuiThe list key
valuestringOuiThe value to prepend to the list

Sortie

ParamètreTypeDescription
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.

Entrée

ParamètreTypeObligatoireDescription
restUrlstringOuiUpstash Redis REST URL
restTokenstringOuiUpstash Redis REST Token
keystringOuiThe list key
startnumberOuiStart index (0-based, negative values count from end)
stopnumberOuiStop index (inclusive, -1 for last element)

Sortie

ParamètreTypeDescription
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.

Entrée

ParamètreTypeObligatoireDescription
restUrlstringOuiUpstash Redis REST URL
restTokenstringOuiUpstash Redis REST Token
keystringOuiThe key to check

Sortie

ParamètreTypeDescription
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.

Entrée

ParamètreTypeObligatoireDescription
restUrlstringOuiUpstash Redis REST URL
restTokenstringOuiUpstash Redis REST Token
keystringOuiThe key to set
valuestringOuiThe value to store if the key does not exist

Sortie

ParamètreTypeDescription
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.

Entrée

ParamètreTypeObligatoireDescription
restUrlstringOuiUpstash Redis REST URL
restTokenstringOuiUpstash Redis REST Token
keystringOuiThe key to increment
incrementnumberOuiAmount to increment by (use negative value to decrement)

Sortie

ParamètreTypeDescription
keystringThe key that was incremented
valuenumberThe new value after incrementing

On this page