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

# AlienVault OTX

Search and share threat intelligence pulses, and enrich IPs, domains, URLs, file hashes, and CVEs with AlienVault OTX (Open Threat Exchange).

### Connectors

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

| Connector      | Authentication |
| -------------- | -------------- |
| AlienVault OTX | API Key        |

#### AlienVault OTX

Connect with an AlienVault OTX API key to search threat intel pulses, enrich indicators of compromise, and share your own pulses with the OTX community.

**Set up in AlienVault OTX**

1. Prepare the AlienVault OTX account or service that the workflow will access. Grant access to the required resources and operations.
2. **API Key:** Log in at otx.alienvault.com, open Settings, and copy the OTX Key shown there.

**Set up in StackAI**

1. Open **Settings → Connections**, add a connection, and select **AlienVault OTX**.
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 Key       | Yes      | Log in at otx.alienvault.com, open Settings, and copy the OTX Key shown there. [Provider instructions](https://otx.alienvault.com/settings). |

#### 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 **AlienVault OTX** 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 Pulses

Find OTX pulses (threat reports) matching a keyword, malware family, adversary, or tag.

**Inputs**

| Field                 | Type    | Required | Description                                                            |
| --------------------- | ------- | -------- | ---------------------------------------------------------------------- |
| Search Query          | string  | Yes      | Keyword to search for, such as a malware family, threat actor, or CVE. |
| Show advanced options | boolean | No       | Show result limit and page controls. Default: false.                   |
| Max Results           | integer | No       | Maximum number of pulses to return (1-100). Default: 25.               |
| Page                  | integer | No       | Page to start from, to continue a previous search.                     |

**Outputs**

| Field       | Type          | Description                                  |
| ----------- | ------------- | -------------------------------------------- |
| Pulses      | object\_array | Matching pulses.                             |
| Total Count | integer       | Total number of matches.                     |
| Next Page   | integer       | Page to request next, if more results exist. |

#### Get Pulse Details

Get the full details of an OTX pulse: description, author, tags, TLP, references, and targeting.

**Inputs**

| Field    | Type   | Required | Description                                                            |
| -------- | ------ | -------- | ---------------------------------------------------------------------- |
| Pulse ID | string | Yes      | The pulse's ID, found in its OTX URL (otx.alienvault.com/pulse/\<id>). |

**Outputs**

| Field | Type   | Description    |
| ----- | ------ | -------------- |
| Pulse | object | Pulse details. |

#### List Pulse Indicators

List the indicators of compromise (IPs, domains, hashes, URLs) contained in a pulse.

**Inputs**

| Field                 | Type            | Required | Description                                                                                                                                              |
| --------------------- | --------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Pulse ID              | string          | Yes      | The pulse's ID, found in its OTX URL.                                                                                                                    |
| Indicator Type        | select (string) | No       | Only return indicators of this type. Available values: All, IPv4, IPv6, domain, hostname, URL, FileHash-MD5, FileHash-SHA1, FileHash-SHA256, CVE, email. |
| Show advanced options | boolean         | No       | Show max results and page. Default: false.                                                                                                               |
| Max Results           | integer         | No       | Maximum number of indicators to return (1-1000). Default: 200.                                                                                           |
| Page                  | integer         | No       | Page to start from, to continue a previous listing.                                                                                                      |

**Outputs**

| Field       | Type          | Description                    |
| ----------- | ------------- | ------------------------------ |
| Indicators  | object\_array | Indicators in the pulse.       |
| Total Count | integer       | Total indicators in the pulse. |
| Next Page   | integer       | Page to request next.          |

#### List Subscribed Pulses

List pulses in your OTX threat feed: pulses you subscribe to, created, or get through users and groups you follow.

**Inputs**

| Field                 | Type     | Required | Description                                              |
| --------------------- | -------- | -------- | -------------------------------------------------------- |
| Modified Since        | datetime | No       | Only return pulses changed after this time.              |
| Show advanced options | boolean  | No       | Show result limit and page controls. Default: false.     |
| Max Results           | integer  | No       | Maximum number of pulses to return (1-100). Default: 25. |
| Page                  | integer  | No       | Page to start from, to continue a previous listing.      |

**Outputs**

| Field       | Type          | Description            |
| ----------- | ------------- | ---------------------- |
| Pulses      | object\_array | Pulses in your feed.   |
| Total Count | integer       | Total pulses matching. |
| Next Page   | integer       | Page to request next.  |

#### Get Indicator Details

Look up threat intelligence for an IP address, domain, hostname, URL, file hash, or CVE.

**Inputs**

| Field                 | Type                      | Required | Description                                                                                                                                                                                                     |
| --------------------- | ------------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Indicator             | string                    | Yes      | The IP address, domain, hostname, URL, file hash, or CVE to look up.                                                                                                                                            |
| Show advanced options | boolean                   | No       | Override the automatically detected indicator type. Default: false.                                                                                                                                             |
| Indicator Type        | select (string)           | No       | Override the automatically detected indicator type. Available values: Auto-detect, IPv4, IPv6, Domain, Hostname, URL, File hash, CVE. Default: auto.                                                            |
| Sections              | multiple\_select (string) | No       | Which kinds of intelligence to fetch. Sections that don't apply to the indicator type are skipped. Available values: General, Reputation, Geo, Malware, URL list, Passive DNS, Analysis. Default: \["general"]. |

**Outputs**

| Field            | Type          | Description                                                   |
| ---------------- | ------------- | ------------------------------------------------------------- |
| Indicator        | string        | The indicator looked up.                                      |
| Indicator Type   | string        | Detected type.                                                |
| Pulse Count      | integer       | Number of OTX pulses mentioning this indicator.               |
| Summary          | object        | Key threat context.                                           |
| Sections         | object        | Raw data for each requested section.                          |
| Skipped Sections | string\_array | Requested sections that don't apply to this indicator type.   |
| Failed Sections  | string\_array | Requested sections AlienVault OTX could not return this time. |

#### Create Pulse

Create an OTX pulse to record and share indicators of compromise. Pulses are private unless you choose to publish them.

**Inputs**

| Field                    | Type            | Required | Description                                                                                              |
| ------------------------ | --------------- | -------- | -------------------------------------------------------------------------------------------------------- |
| Name                     | string          | Yes      | Title of the pulse.                                                                                      |
| Description              | textarea        | No       | What this threat is and how the indicators were observed.                                                |
| Indicators               | textarea        | No       | Indicators to include, one per line or comma-separated. Types are detected automatically.                |
| Publish to OTX Community | boolean         | No       | Make the pulse visible to everyone on OTX. Leave off to keep it private to your account. Default: false. |
| Show advanced options    | boolean         | No       | Show TLP, tags, references, and other optional pulse metadata. Default: false.                           |
| TLP                      | select (string) | No       | Traffic Light Protocol sharing level for the pulse. Available values: White, Green, Amber, Red.          |
| Tags                     | string          | No       | Comma-separated tags.                                                                                    |
| References               | string          | No       | Comma-separated links to reports or articles about this threat.                                          |
| Malware Families         | string          | No       | Comma-separated malware families involved.                                                               |
| Adversary                | string          | No       | Threat actor behind the activity, if known.                                                              |
| MITRE ATT\&CK IDs        | string          | No       | Comma-separated MITRE ATT\&CK technique IDs.                                                             |
| Targeted Industries      | string          | No       | Comma-separated industries targeted.                                                                     |
| Targeted Countries       | string          | No       | Comma-separated countries targeted.                                                                      |

**Outputs**

| Field           | Type    | Description                  |
| --------------- | ------- | ---------------------------- |
| Pulse ID        | string  | ID of the new pulse.         |
| Name            | string  | Pulse name.                  |
| URL             | string  | Link to the pulse on OTX.    |
| Public          | boolean | Whether the pulse is public. |
| Indicator Count | integer | Number of indicators added.  |

#### Subscribe to Pulse

Subscribe to a pulse so it and its updates appear in your OTX threat feed.

**Inputs**

| Field    | Type   | Required | Description                           |
| -------- | ------ | -------- | ------------------------------------- |
| Pulse ID | string | Yes      | The pulse's ID, found in its OTX URL. |

**Outputs**

| Field            | Type    | Description                     |
| ---------------- | ------- | ------------------------------- |
| Pulse ID         | string  | Pulse subscribed to.            |
| Subscribed       | boolean | Whether you are now subscribed. |
| Subscriber Count | integer | Total subscribers of the pulse. |

#### Unsubscribe from Pulse

Stop following a pulse in your OTX threat feed.

**Inputs**

| Field    | Type            | Required | Description                                                                                         |
| -------- | --------------- | -------- | --------------------------------------------------------------------------------------------------- |
| Pulse ID | select (string) | Yes      | Pick one of your subscribed pulses, or paste a pulse ID. Options load from the selected connection. |

**Outputs**

| Field            | Type    | Description                       |
| ---------------- | ------- | --------------------------------- |
| Pulse ID         | string  | Pulse unsubscribed from.          |
| Subscribed       | boolean | Whether you are still subscribed. |
| Subscriber Count | integer | Total subscribers of the pulse.   |

### 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/alienvault-otx.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.
