Redis Component

Manage items in a Redis database

Component key: redis ·

• API Docs
• Changelog

· Changelog ↓

Description

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

API Documentation

This component was built using the Redis command reference.

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

Connections

Redis Connection

key: redis

A Redis connection requires host and port information, along with optional authentication and TLS configuration.

Prerequisites

• A Redis server instance accessible from the network
• Authentication credentials if the server requires them

Configure the Connection

• Host: Enter the hostname or IP address of the Redis server
• Port: Enter the Redis server port (default is typically 6379)
• Password: Enter the Redis server password
• Username: Enter the Redis username (optional - required only if ACL-based authentication is enabled)
• Database: Enter the logical database number to connect to (optional, e.g., 0)

TLS Configuration

For encrypted connections, enable TLS and provide the necessary certificates:

• Use TLS: Set to true to enable TLS for the connection
• Client Key: Provide the client private key for mutual TLS authentication (optional)
• Client Certificate: Provide the client certificate for mutual TLS authentication (optional)
• CA Certificate: Provide the CA certificate to verify the server's identity (optional - if not provided, the server certificate is not verified)

Input	Notes	Example
CA Certificate	Provide the CA certificate for the TLS connection. If not provided, the connection will not be verified.
Client Certificate	Provide the client certificate for the TLS connection.
Database	Select a logical database to connect to.	0
Host	Provide the string value for the host of the server.	192.168.0.1
Client Key	Provide the client key for the TLS connection.
Password
Port	The port of the redis server.
Username
Use TLS	Set to true to enable TLS for the connection.	false

Actions

Delete Key

Delete the value of a key | key: deleteKey

Input	Notes	Example
Key	Provide a string value for key of the item.	customerId
Connection

{
  "data": 1
}

---

Flush All

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

Input	Notes	Example
Connection

{
  "data": "OK"
}

---

Get

Get the value of a key | key: get

Input	Notes	Example
Key	Provide a string value for key of the item.	customerId
Connection

{
  "data": "myValue"
}

---

Get Time

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

Input	Notes	Example
Connection

{
  "data": "2024-05-20T23:01:37.700Z"
}

---

Keys

Returns all keys matching a specified pattern | key: keys

Input	Notes	Example
Key	Provide a string value for key of the item.	customerId
Connection

{
  "data": [
    "key1",
    "key2",
    "key3"
  ]
}

---

Ping

Send a ping to the redis server | key: ping

Input	Notes	Example
Connection

{
  "data": "PONG"
}

---

Set

Set the value of a key | key: set

Input	Notes	Example
Key	Provide a string value for key of the item.	customerId
Connection
Value	Provide a string for the value to be set.	cust#3017

{
  "data": "OK"
}

---

Changelog

2026-04-10

Updated example payloads

2026-04-07

Added global debug support across all actions for improved troubleshooting

2026-03-16

Improved input field documentation with formatted URL links for better readability