> For the complete documentation index, see [llms.txt](https://docs.stackai.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.stackai.com/integrations/catalog/sumo-logic.md).

# Sumo Logic

Search operational logs and investigate Cloud SIEM signals and insights in Sumo Logic.

## Connectors

Choose the connector that matches your authentication method. The options below use the names shown in StackAI.

| Connector  | Authentication |
| ---------- | -------------- |
| Sumo Logic | Access Key     |

### Sumo Logic

Connect to Sumo Logic to search logs and investigate Cloud SIEM signals and insights.

#### Set up in Sumo Logic

1. Prepare the Sumo Logic account or service that the workflow will access. Grant access to the required resources and operations.
2. **Access ID:** The access ID from Administration > Security > Access Keys in Sumo Logic. It uses the permissions of the user or service account that created it.
3. **Access Key:** The access key paired with the access ID. Sumo Logic displays it only once when the key is created.

#### Set up in StackAI

1. Open **Settings → Connections**, add a connection, and select **Sumo Logic**.
2. Enter the credentials and connection details in the fields below.
3. Save the connection and check its connection status. Select this saved connection when configuring an action or feature that uses it.

**Connection fields**

| StackAI field | Required                 | What to enter                                                                                                                                                                                                                                |
| ------------- | ------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Access ID     | Yes                      | The access ID from Administration > Security > Access Keys in Sumo Logic. It uses the permissions of the user or service account that created it. [Provider instructions](https://www.sumologic.com/help/docs/manage/security/access-keys/). |
| Access Key    | Yes                      | The access key paired with the access ID. Sumo Logic displays it only once when the key is created. [Provider instructions](https://www.sumologic.com/help/docs/manage/security/access-keys/).                                               |
| Deployment    | Optional / as applicable | Select the deployment shown in your Sumo Logic service URL. US1 uses the suffix-less service.sumologic.com host.                                                                                                                             |

### Verify the connection

Check that the connection is healthy. Then run a read operation against a resource the connected account can access. A successful connection check confirms authentication; it does not guarantee permission for every action.

If access is denied, check the credential or OAuth permissions, the selected account or environment, and access to the specific resource. Update expired credentials or reconnect after permissions change.

## Use an action

1. Add the required **Sumo Logic** action to the workflow.
2. Select a connection when the action requests one.
3. Complete the required fields. Use the reference picker when a value comes from another workflow step.
4. Run the workflow and inspect the action’s output. Check the result before using it in a later step.

## Actions

### Run log search

Run a Sumo Logic log search to completion and return its matching raw messages.

#### Inputs

| Field              | Type            | Required | Description                                                                                                                                          |
| ------------------ | --------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
| Search query       | textarea        | Yes      | The Sumo Logic log query to run.                                                                                                                     |
| Start time         | datetime        | Yes      | Beginning of the time range to search.                                                                                                               |
| End time           | datetime        | Yes      | End of the time range to search.                                                                                                                     |
| Time zone          | string          | Yes      | Time zone used to interpret the search range. Default: UTC.                                                                                          |
| Message time basis | select (string) | Yes      | Which message timestamp Sumo Logic should apply to the range. Available values: Message time, Receipt time, Searchable time. Default: message\_time. |
| Parsing mode       | select (string) | Yes      | Whether Sumo Logic should automatically parse fields while searching. Available values: Automatic, Manual. Default: AutoParse.                       |
| Maximum messages   | integer         | Yes      | Most raw messages to return from the completed search. Minimum: 1. Maximum: 5000. Default: 1000.                                                     |
| Maximum wait       | integer         | Yes      | Longest time to wait for the search job to finish. Minimum: 30. Maximum: 900. Default: 300.                                                          |

#### Outputs

| Field                  | Type          | Description                                               |
| ---------------------- | ------------- | --------------------------------------------------------- |
| Search job ID          | string        | Identifier of the temporary Sumo Logic search job.        |
| Matching message count | integer       | Total raw messages reported by the completed job.         |
| Messages               | object\_array | Raw matching log messages with their Sumo Logic fields.   |
| Field metadata         | object\_array | Names and types of fields present in the message results. |
| Results truncated      | boolean       | Whether more matches exist after this returned batch.     |
| Provider warning       | string        | Any warning Sumo Logic returned for the search.           |

### List Signals

Find Cloud SIEM signals for security triage.

#### Inputs

| Field             | Type     | Required | Description                                                           |
| ----------------- | -------- | -------- | --------------------------------------------------------------------- |
| Created after     | datetime | No       | Only include signals created at or after this time.                   |
| Created before    | datetime | No       | Only include signals created at or before this time.                  |
| Minimum severity  | integer  | No       | Only include signals at or above this severity. Minimum: 0.           |
| Additional filter | textarea | No       | Optional additional Cloud SIEM filter expression.                     |
| Start offset      | integer  | No       | Offset to resume from a previous result page. Minimum: 0. Default: 0. |
| Maximum results   | integer  | Yes      | Most signals to return. Minimum: 1. Maximum: 1000. Default: 100.      |

#### Outputs

| Field         | Type          | Description                                                             |
| ------------- | ------------- | ----------------------------------------------------------------------- |
| Signals       | object\_array | Cloud SIEM signals matching the filters.                                |
| Total matches | integer       | Total signals matching the query within Sumo Logic's 10,000-result cap. |
| Next offset   | integer       | Offset for the next batch, or empty when finished.                      |

### List Insights

Find and prioritize Cloud SIEM insights.

#### Inputs

| Field                 | Type            | Required | Description                                                                                                                                                                                                                                    |
| --------------------- | --------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Status                | select (string) | No       | Only include insights in this workflow status. Options load from the selected connection.                                                                                                                                                      |
| Minimum severity      | select (string) | No       | Only include insights at or above this severity. Available values: Low, Medium, High, Critical.                                                                                                                                                |
| Created after         | datetime        | No       | Only include insights created at or after this time.                                                                                                                                                                                           |
| Created before        | datetime        | No       | Only include insights created at or before this time.                                                                                                                                                                                          |
| Additional filter     | textarea        | No       | Optional additional Cloud SIEM insight filter expression.                                                                                                                                                                                      |
| Sort by               | select (string) | Yes      | Insight field used to prioritize the result list. Available values: Assignee, Confidence, Created, Entity name, Name, Relevance, Serial ID, Severity, Signal count, Status, Timestamp, Triage verdict, Unique signal count. Default: SEVERITY. |
| Sort direction        | select (string) | Yes      | Whether lower or higher sort values appear first. Available values: Ascending, Descending. Default: DESC.                                                                                                                                      |
| Record summary fields | string          | Yes      | Record fields to aggregate into value counts for each insight. Default: srcDevice\_ip,dstDevice\_ip,user\_username.                                                                                                                            |
| Include heavy details | boolean         | Yes      | Include nested artifacts and signal records that can make responses large. Default: false.                                                                                                                                                     |
| Start offset          | integer         | No       | Offset to resume from a previous result page. Minimum: 0. Default: 0.                                                                                                                                                                          |
| Maximum results       | integer         | Yes      | Most insights to return. Minimum: 1. Maximum: 1000. Default: 100.                                                                                                                                                                              |

#### Outputs

| Field         | Type          | Description                                                              |
| ------------- | ------------- | ------------------------------------------------------------------------ |
| Insights      | object\_array | Cloud SIEM insights matching the filters.                                |
| Total matches | integer       | Total insights matching the query within Sumo Logic's 10,000-result cap. |
| Next offset   | integer       | Offset for the next batch, or empty when finished.                       |

### Get Insight

Retrieve the complete details of one Cloud SIEM insight.

#### Inputs

| Field                 | Type            | Required | Description                                                                                        |
| --------------------- | --------------- | -------- | -------------------------------------------------------------------------------------------------- |
| Insight               | select (string) | Yes      | Insight to retrieve. Options load from the selected connection.                                    |
| Record summary fields | string          | Yes      | Record fields to aggregate into value counts. Default: srcDevice\_ip,dstDevice\_ip,user\_username. |
| Include heavy details | boolean         | Yes      | Include nested artifacts and complete signal records. Default: true.                               |

#### Outputs

| Field   | Type   | Description                          |
| ------- | ------ | ------------------------------------ |
| Insight | object | Complete Cloud SIEM insight details. |

### List Insight Workflow Options

List the configured statuses and resolutions available for insight workflow updates.

#### Inputs

| Field                     | Type    | Required | Description                                                                         |
| ------------------------- | ------- | -------- | ----------------------------------------------------------------------------------- |
| Include disabled statuses | boolean | Yes      | Include statuses disabled in the Sumo Logic workflow configuration. Default: false. |
| Resolution start offset   | integer | No       | Offset to resume resolution listing. Minimum: 0. Default: 0.                        |
| Maximum resolutions       | integer | Yes      | Most configured resolutions to return. Minimum: 1. Maximum: 500. Default: 100.      |

#### Outputs

| Field                  | Type          | Description                                                   |
| ---------------------- | ------------- | ------------------------------------------------------------- |
| Statuses               | object\_array | Configured insight workflow statuses.                         |
| Resolutions            | object\_array | Configured resolutions available when closing an insight.     |
| Next resolution offset | integer       | Offset for the next resolution batch, or empty when finished. |

### Update Insight Status

Move a Cloud SIEM insight to another investigation status.

#### Inputs

| Field      | Type            | Required | Description                                                                    |
| ---------- | --------------- | -------- | ------------------------------------------------------------------------------ |
| Insight    | select (string) | Yes      | Insight whose status should change. Options load from the selected connection. |
| New status | select (string) | Yes      | Workflow status to assign. Options load from the selected connection.          |
| Resolution | select (string) | No       | Reason the insight is being closed. Options load from the selected connection. |

#### Outputs

| Field           | Type   | Description                      |
| --------------- | ------ | -------------------------------- |
| Updated insight | object | Insight after the status update. |

## Triggers

A trigger starts a workflow when its configured event occurs. Configure the event and filters before enabling the trigger.

### New signal

Poll Cloud SIEM every five minutes for newly created signals. Each complete poll drains its short-lived page cursor and retains a five-minute overlap when advancing the persisted watermark.

Optionally set a minimum severity or an additional Cloud SIEM filter. The additional filter is combined with one fixed created-time window, reused unchanged while every page drains, and the next poll overlaps it by five minutes for late-arriving signals.

#### Configuration

| Field             | Type     | Required | Description                                                     |
| ----------------- | -------- | -------- | --------------------------------------------------------------- |
| Minimum severity  | integer  | No       | Only trigger for signals at or above this severity. Minimum: 0. |
| Additional filter | textarea | No       | Optional additional filter applied to each polling window.      |

#### Event inputs

| Field  | Type   | Required | Description                          |
| ------ | ------ | -------- | ------------------------------------ |
| Signal | object | Yes      | The newly created Cloud SIEM signal. |

#### Outputs

| Field  | Type   | Description                          |
| ------ | ------ | ------------------------------------ |
| Signal | object | The newly created Cloud SIEM signal. |

## Important behavior

Actions that create, update, send, or delete data can change the connected service. Review their inputs before running them. A retry can repeat an operation; consider this when configuring retries for actions that change data.

The catalog lists the fields and capabilities available in the supplied provider definition. Availability can also depend on your deployment and organization’s Feature Access settings.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.stackai.com/integrations/catalog/sumo-logic.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
