Skip to main content

Redis Component

Manage items in a Redis database

Component key: redis

Description#

[Redis] is an in-memory data structure store, used as a distributed, in-memory key–value database, cache and message broker. The Redis component provides the ability to create, read, update, and delete data inside a Redis database.

This component returns data that can be used in subsequent steps.

Actions#

Delete Key#

Delete the value of a key | key: deleteKey

InputKeyDefaultNotesExample

Host

string
/ Required
hostProvide a string value for the host address of the Redis server.192.168.0.1

Key

string
/ Required
keyProvide a string value for key of the item.customerId

Port

string
/ Required
port6379Provide a string value for the port of the Redis server.6379

Authorization#

Authorization is not required for this action.
Auth TypeKeyDescriptionFields
Basic AuthbasicBasic authorization using a username/password combination

Username |  username

Password |  password

Output Example Payload#

{  "data": {}}

Flush All#

Delete all the keys of all the existing databases, not just the currently selected one | key: flushAll

InputKeyDefaultNotesExample

Host

string
/ Required
hostProvide a string value for the host address of the Redis server.192.168.0.1

Port

string
/ Required
port6379Provide a string value for the port of the Redis server.6379

Authorization#

Authorization is not required for this action.
Auth TypeKeyDescriptionFields
Basic AuthbasicBasic authorization using a username/password combination

Username |  username

Password |  password

Output Example Payload#

{  "data": {}}

Get#

Get the value of a key | key: get

InputKeyDefaultNotesExample

Database

string
dbProvide a string value for the name of the Redis database. If set, client will run Redis select command on connect.myDatabase

Host

string
/ Required
hostProvide a string value for the host address of the Redis server.192.168.0.1

Key

string
/ Required
keyProvide a string value for key of the item.customerId

Port

string
/ Required
port6379Provide a string value for the port of the Redis server.6379

Authorization#

Authorization is not required for this action.
Auth TypeKeyDescriptionFields
Basic AuthbasicBasic authorization using a username/password combination

Username |  username

Password |  password

Output Example Payload#

{  "data": "myValue"}

Get Time#

Get the local time of the redis server | key: getTime

InputKeyDefaultNotesExample

Host

string
/ Required
hostProvide a string value for the host address of the Redis server.192.168.0.1

Port

string
/ Required
port6379Provide a string value for the port of the Redis server.6379

Authorization#

Authorization is not required for this action.
Auth TypeKeyDescriptionFields
Basic AuthbasicBasic authorization using a username/password combination

Username |  username

Password |  password

Output Example Payload#

{  "data": "12:34"}

Keys#

Returns all keys matching a specified pattern | key: keys

InputKeyDefaultNotesExample

Database

string
dbProvide a string value for the name of the Redis database. If set, client will run Redis select command on connect.myDatabase

Host

string
/ Required
hostProvide a string value for the host address of the Redis server.192.168.0.1

Key

string
/ Required
keyProvide a string value for key of the item.customerId

Port

string
/ Required
port6379Provide a string value for the port of the Redis server.6379

Authorization#

Authorization is not required for this action.
Auth TypeKeyDescriptionFields
Basic AuthbasicBasic authorization using a username/password combination

Username |  username

Password |  password

Output Example Payload#

{  "data": {}}

Ping#

Send a ping to the redis server | key: ping

InputKeyDefaultNotesExample

Database

string
dbProvide a string value for the name of the Redis database. If set, client will run Redis select command on connect.myDatabase

Host

string
/ Required
hostProvide a string value for the host address of the Redis server.192.168.0.1

Key

string
/ Required
keyProvide a string value for key of the item.customerId

Port

string
/ Required
port6379Provide a string value for the port of the Redis server.6379

Authorization#

Authorization is not required for this action.
Auth TypeKeyDescriptionFields
Basic AuthbasicBasic authorization using a username/password combination

Username |  username

Password |  password

Output Example Payload#

{  "data": "pong"}

Set#

Set the value of a key | key: set

InputKeyDefaultNotesExample

Database

string
dbProvide a string value for the name of the Redis database. If set, client will run Redis select command on connect.myDatabase

Host

string
/ Required
hostProvide a string value for the host address of the Redis server.192.168.0.1

Key

string
/ Required
keyProvide a string value for key of the item.customerId

Port

string
/ Required
port6379Provide a string value for the port of the Redis server.6379

Value

string
/ Required
valueProvide a string for the value to be set.cust#3017

Authorization#

Authorization is not required for this action.
Auth TypeKeyDescriptionFields
Basic AuthbasicBasic authorization using a username/password combination

Username |  username

Password |  password

Output Example Payload#

{  "data": "Ok"}