> 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/papertrail.md).

# Papertrail

Search logs, inspect entities, and get archive download links.

### Connectors

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

| Connector  | Authentication |
| ---------- | -------------- |
| Papertrail | API token      |

#### Papertrail

Connect to Papertrail on SolarWinds Observability with an API Access token and data center.

**Set up in Papertrail**

1. Prepare the Papertrail account or service that the workflow will access. Grant access to the required resources and operations.
2. **API token:** Create an API Access token in SolarWinds Observability Settings > API Tokens.
3. **Data center:** Use the data center from your portal URL: my.na-01.cloud.solarwinds.com means na-01.

**Set up in StackAI**

1. Open **Settings → Connections**, add a connection, and select **Papertrail**.
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                                                                                                                                                                                                |
| ------------- | ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| API token     | Yes                      | Create an API Access token in SolarWinds Observability Settings > API Tokens. [Provider instructions](https://documentation.solarwinds.com/en/success_center/observability/content/settings/api-tokens.htm). |
| Data center   | Optional / as applicable | Use the data center from your portal URL: my.na-01.cloud.solarwinds.com means na-01.                                                                                                                         |

#### 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 **Papertrail** 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

#### Search Log Events

Find logs by query, entity, group, or time range.

**Inputs**

| Field           | Type            | Required | Description                                                                                                       |
| --------------- | --------------- | -------- | ----------------------------------------------------------------------------------------------------------------- |
| Maximum results | integer         | No       | Number of results to request, up to 1000. Minimum: 1. Maximum: 1000. Default: 100.                                |
| Page token      | string          | No       | Continue using the token from a previous result.                                                                  |
| Search query    | textarea        | No       | Find logs using Papertrail search syntax. Leave blank for all logs.                                               |
| Log group       | string          | No       | Optionally narrow the logs to a group.                                                                            |
| Entity          | select (string) | No       | Return logs associated with an entity. Some entities may have no logs. Options load from the selected connection. |
| Start time      | datetime        | No       | Earliest time to include.                                                                                         |
| End time        | datetime        | No       | Latest time to include.                                                                                           |

**Outputs**

| Field              | Type          | Description                                                        |
| ------------------ | ------------- | ------------------------------------------------------------------ |
| Log events         | object\_array | The matching log events.                                           |
| Continuation token | string        | Resume this search. A token does not guarantee more matching logs. |

#### Get Entity

Get details for a SolarWinds entity of any type.

**Inputs**

| Field  | Type            | Required | Description                                                                                     |
| ------ | --------------- | -------- | ----------------------------------------------------------------------------------------------- |
| Entity | select (string) | Yes      | Select an entity or enter its ID from List Entities. Options load from the selected connection. |

**Outputs**

| Field  | Type   | Description                                                             |
| ------ | ------ | ----------------------------------------------------------------------- |
| Entity | object | Entity details, including type, status, tags, and available attributes. |

#### List Log Archives

Find Papertrail log archives in a time range.

**Inputs**

| Field           | Type     | Required | Description                                                                        |
| --------------- | -------- | -------- | ---------------------------------------------------------------------------------- |
| Start time      | datetime | Yes      | Start of the archive time range, within the last year.                             |
| End time        | datetime | Yes      | End of the archive time range, within the last year.                               |
| Maximum results | integer  | No       | Number of results to request, up to 1000. Minimum: 1. Maximum: 1000. Default: 100. |
| Page token      | string   | No       | Continue using the token from a previous result.                                   |

**Outputs**

| Field           | Type          | Description                                              |
| --------------- | ------------- | -------------------------------------------------------- |
| Log archives    | object\_array | Available archives, including IDs, filenames, and sizes. |
| Next page token | string        | Token to retrieve more archives, or null when complete.  |

#### List Entities

List SolarWinds entities, optionally filtered by type.

**Inputs**

| Field           | Type            | Required | Description                                                                                                    |
| --------------- | --------------- | -------- | -------------------------------------------------------------------------------------------------------------- |
| Maximum results | integer         | No       | Number of results to request, up to 1000. Minimum: 1. Maximum: 1000. Default: 100.                             |
| Page token      | string          | No       | Continue using the token from a previous result.                                                               |
| Entity type     | select (string) | No       | Optionally select an entity type. Leave blank to include all types. Options load from the selected connection. |

**Outputs**

| Field           | Type          | Description                                                              |
| --------------- | ------------- | ------------------------------------------------------------------------ |
| Entities        | object\_array | Entities and their types, names, status, tags, and available attributes. |
| Next page token | string        | Token to retrieve more entities, or null when complete.                  |

#### Get Log Archive Download URL

Get a direct download link for a compressed Papertrail log archive.

**Inputs**

| Field       | Type            | Required | Description                                                                            |
| ----------- | --------------- | -------- | -------------------------------------------------------------------------------------- |
| Start time  | datetime        | Yes      | Start of the archive time range, within the last year.                                 |
| End time    | datetime        | Yes      | End of the archive time range, within the last year.                                   |
| Log archive | select (string) | Yes      | Choose an available compressed log archive. Options load from the selected connection. |

**Outputs**

| Field        | Type   | Description                                                     |
| ------------ | ------ | --------------------------------------------------------------- |
| Download URL | string | SolarWinds download link. If it expires, run this action again. |
| Filename     | string | Archive filename.                                               |

### 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/papertrail.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.
