# Redis

This document provides guidance on how to integrate Redis with
Google SecOps.

## Configure Redis integration in Google Security Operations

For detailed instructions on how to configure an integration in
Google SecOps, see [Configure
integrations](https://docs.cloud.google.com/chronicle/docs/soar/respond/integrations-setup/configure-integrations).

## Actions

### Add to List

#### Description

Add a value to the head of a Redis list. If the list does not exist then create
a new list.

#### Parameters

| Parameter | Type | Default Value | Description |
|---|---|---|---|
| List Name | String | N/A | Target list name. |
| Value | String | N/A | Can be any of the following types: str, int, dict, list, etc. |

#### Run On

This action runs on all entities.

#### Action Results

##### Entity Enrichment

N/A

##### Insights

N/A

##### Script Result

| Script Result Name | Value Options | Example |
|---|---|---|
| is_added | True/False | is_added:False |

##### JSON Result

    [
        "value1",
        "value2",
        "value3"
    ]

### Get Key

#### Description

Return the value at the selected key, or return none if the key doesn't exist

#### Parameters

| Parameter | Type | Default Value | Description |
|---|---|---|---|
| Key Name | String | N/A | Target key name. |

#### Run On

This action runs on all entities.

#### Action Results

##### Entity Enrichment

N/A

##### Insights

N/A

##### Script Result

| Script Result Name | Value Options | Example |
|---|---|---|
| key_value | True/False | key_value:False |

##### JSON Result

    N/A

### Get List

#### Description

Return the value of an element from a Redis list.

#### Parameters

| Parameter | Type | Default Value | Description |
|---|---|---|---|
| List Name | String | N/A | Target list name. |

#### Run On

This action runs on all entities.

#### Action Results

##### Entity Enrichment

N/A

##### Insights

N/A

##### Script Result

| Script Result Name | Value Options | Example |
|---|---|---|
| is_success | True/False | is_success:False |

##### JSON Result

    N/A

### Ping

#### Description

Verifies that the user has a connection to Redis through the user's device.

#### Parameters

N/A

#### Run On

This action runs on all entities.

#### Action Results

##### Entity Enrichment

N/A

##### Insights

N/A

##### Script Result

| Script Result Name | Value Options | Example |
|---|---|---|
| is_connect | True/False | is_connect:False |

##### JSON Result

    N/A

### Set Key

#### Description

Set a string value in a Redis key. If the key already holds a value, then
overwrite the value regardless of its type.

#### Parameters

| Parameter | Type | Default Value | Description |
|---|---|---|---|
| Key Name | String | N/A | Target key name. |
| Value | String | N/A | Can be any of the following types: str, int, dict, list, etc. |

#### Run On

This action runs on all entities.

#### Action Results

##### Entity Enrichment

N/A

##### Insight

N/A

##### Script Result

| Script Result Name | Value Options | Example |
|---|---|---|
| is_set | True/False | is_set:False |

##### JSON Result

    N/A

**Need more help?** [Get answers from Community members and Google SecOps professionals.](https://security.googlecloudcommunity.com/)