---
canonical_url: "https://docs.composio.dev/toolkits/shodan"
markdown_url: "https://docs.composio.dev/toolkits/shodan.md"
product: "platform"
version: null
last_updated: null
---

# Shodan

Shodan provides Internet intelligence for discovering exposed devices and services, searching host data, monitoring network exposure, and consuming real-time collection feeds.

- **Category:** security & identity tools
- **Auth:** API_KEY
- **Composio-managed OAuth available?** N/A
- **Tools:** 45
- **Triggers:** 0
- **Slug:** `SHODAN`
- **Version:** 00000000_00

## Tools

### Add Alert Notifier

**Slug:** `SHODAN_ADD_ALERT_NOTIFIER`

Attach an existing notifier to a paid Shodan network alert. This changes notification routing: future matching alert events may be delivered to the notifier's external destination. Verify both ids and the destination before calling.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `alert_id` | string | Yes | Network alert id to modify. |
| `notifier_id` | string | Yes | Notifier id to attach to the network alert. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add Organization Member

**Slug:** `SHODAN_ADD_ORGANIZATION_MEMBER`

Add a Shodan user to the connected Enterprise organization and upgrade their account, granting organization access. This is an administrative membership mutation. When notify is true, Shodan also sends an external email notification to the user about the invitation or access change; confirm the intended username or email address and access change before calling.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `user` | string | Yes | Shodan username or email address of the user to add and upgrade. |
| `notify` | boolean | No | Whether Shodan should send the user an email notification. Omit this parameter to leave notification behavior unspecified. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Count Hosts

**Slug:** `SHODAN_COUNT_HOSTS`

Count hosts matching a Shodan search query and optionally return facet counts, without returning banners or consuming query credits for a plain count.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `query` | string | Yes | Shodan search query to count. |
| `facets` | string | No | Comma-separated facets, optionally with counts such as country:10. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Network Alert

**Slug:** `SHODAN_CREATE_NETWORK_ALERT`

Create continuous Shodan monitoring for specified IP addresses or CIDR ranges. This paid operation changes account monitoring state and consumes monitored-IP capacity for the expanded ranges. Review the complete target set and available capacity before calling; the alert remains active until it expires or is deleted.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Human-readable name for the network alert. |
| `expires` | integer | No | Optional number of seconds the alert remains active. Omit it to use Shodan's default; 0 creates an alert without a scheduled expiration. |
| `ip_addresses` | array | Yes | IP addresses or CIDR ranges to monitor continuously. Each address in the expanded ranges uses the account's paid monitored-IP capacity. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Notifier

**Slug:** `SHODAN_CREATE_NOTIFIER`

Create a reusable Shodan notification destination. This does not affect alert routing until the notifier is attached to an alert, and it does not send a test notification. Provider arguments may contain personal contact details or secrets such as webhook URLs, routing keys, and access tokens; confirm the destination and avoid exposing these values.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `provider` | string | Yes | Provider name returned by List Notifier Providers. |
| `arguments` | object | Yes | Provider-specific fields returned by List Notifier Providers, such as {'to': 'address'} or {'url': 'webhook URL'}. Values may contain personal contact details, webhook URLs, routing keys, or access tokens; confirm the destination and do not expose or log these values unnecessarily. |
| `description` | string | Yes | Human-readable description of the notification destination. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Network Alert

**Slug:** `SHODAN_DELETE_NETWORK_ALERT`

Permanently delete a Shodan network alert and stop monitoring its configured IP addresses or CIDR ranges. This destructive paid-account action cannot be undone; verify the alert id before calling it.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `alert_id` | string | Yes | Network alert id to permanently delete. Deletion immediately stops monitoring for the alert and cannot be undone. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Notifier

**Slug:** `SHODAN_DELETE_NOTIFIER`

Permanently delete a Shodan notification service. This destructive action cannot be undone and can stop delivery for every alert that uses the notifier. Never delete the account's default notifier; verify the notifier id and its alert dependencies before calling.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `notifier_id` | string | Yes | Notifier id to permanently delete. Never delete the account's default notifier; verify the id and alert dependencies before calling. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Disable Alert Trigger

**Slug:** `SHODAN_DISABLE_ALERT_TRIGGER`

Disable one or more trigger rules on a paid Shodan network alert. This changes the alert configuration and prevents those trigger types from generating future alert events and notifications; verify the trigger names before calling.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `alert_id` | string | Yes | Network alert id to modify. |
| `triggers` | string | Yes | One or more trigger names to disable. Supply a comma-separated string or an array of names; disabled triggers stop generating future alert events. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Enable Alert Trigger

**Slug:** `SHODAN_ENABLE_ALERT_TRIGGER`

Enable one or more trigger rules on a paid Shodan network alert. This mutates the alert configuration and can cause future matching events to generate notifications; verify the alert id and trigger names before calling.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `alert_id` | string | Yes | Network alert id whose trigger configuration will change. |
| `triggers` | string | Yes | One or more trigger names to enable. Supply a comma-separated string or an array of names; enabling triggers changes the alert's configuration and can cause future matching events to generate notifications. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Account Profile

**Slug:** `SHODAN_GET_ACCOUNT_PROFILE`

Return membership status, credits, display name, username, creation time, and additional profile fields for the owner of the connected Shodan API key. This response contains private account identity, contact, and subscription information; disclose or store it only when necessary.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get API Plan Information

**Slug:** `SHODAN_GET_API_PLAN_INFORMATION`

Return the connected API key's Shodan plan, query and scan credits, monitored-IP allowance, usage limits, and unlocked protocol features.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Domain Information

**Slug:** `SHODAN_GET_DOMAIN_INFORMATION`

Return one page of subdomains and DNS records for a domain. Each lookup consumes 1 Shodan query credit and requires Shodan Membership or higher.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Initial 1-based page; Shodan returns up to 100 DNS records per page. |
| `domain` | string | Yes | Domain name to inspect, without a URL path. |
| `history` | boolean | No | Include historical DNS records when true. |
| `next_cursor` | string | No | Continuation cursor returned by a previous call. When supplied, it determines the next page; repeat domain, history, and record_type. |
| `record_type` | string ("A" | "AAAA" | "CNAME" | "NS" | "SOA" | "MX" | "TXT") | No | Restrict records to one DNS type. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Execution Egress IP

**Slug:** `SHODAN_GET_EXECUTION_EGRESS_IP`

Return the public source IP address Shodan observes for this API request. When called through Composio, this is normally the outbound proxy or execution environment address, not the end user's device IP address.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Host Information

**Slug:** `SHODAN_GET_HOST_INFORMATION`

Return Shodan's current or historical service observations for one IP address. The main REST API host lookup requires Shodan Membership or higher.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ip` | string | Yes | IPv4 or IPv6 address to inspect. |
| `minify` | boolean | No | Return only ports and general host information when true, omitting full service banners. |
| `history` | boolean | No | Include historical service banners when true. Large removed fields are identified in each banner's metadata.truncated list. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Network Alert

**Slug:** `SHODAN_GET_NETWORK_ALERT`

Get one Shodan network alert, including its filters, triggers, and attached notifiers. Paid monitoring capacity is required to have active alerts.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `alert_id` | string | Yes | Network alert id. |
| `include_expired` | boolean | No | Include the alert when it has expired, when supported by the account. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Notifier

**Slug:** `SHODAN_GET_NOTIFIER`

Get one Shodan notification service and its provider-specific destination arguments. The response can contain personal or secret routing data.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `notifier_id` | string | Yes | Notifier id to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Observed Request Headers

**Slug:** `SHODAN_GET_OBSERVED_REQUEST_HEADERS`

Return the HTTP request headers Shodan observes for this Composio API call. Use this transport diagnostic to inspect proxy-visible request metadata, not to retrieve headers from an Internet host.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Organization

**Slug:** `SHODAN_GET_ORGANIZATION`

Return the connected account's Shodan organization, administrators, members, member upgrade, authorized domains, and branding. This Enterprise-only response contains private usernames and email addresses. Accounts without the organization entitlement can receive an HTML 403 response, which this action reports as an entitlement error.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Scan Status

**Slug:** `SHODAN_GET_SCAN_STATUS`

Return the submission or processing status of one Shodan on-demand scan. Creating on-demand scans requires a paid API plan and consumes scan credits.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `scan_id` | string | Yes | Scan id returned by Request Scan, Request Internet Scan, or List Scans. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Ignore Alert Service

**Slug:** `SHODAN_IGNORE_ALERT_SERVICE`

Add one IP:port service to a Shodan network alert trigger's ignore list so matching events no longer notify. This paid-account action changes future notification behavior for the selected trigger.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `service` | string | Yes | Service to ignore in IP:port form. |
| `trigger` | string | Yes | Enabled alert trigger whose matching service notifications will be ignored. |
| `alert_id` | string | Yes | Network alert id whose trigger ignore list will change. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Alert Triggers

**Slug:** `SHODAN_LIST_ALERT_TRIGGERS`

List trigger rules that can be enabled on Shodan network alerts. Configuring network alerts requires paid monitoring access.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Crawled Ports

**Slug:** `SHODAN_LIST_CRAWLED_PORTS`

List TCP and UDP port numbers currently crawled by Shodan.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Dataset Files

**Slug:** `SHODAN_LIST_DATASET_FILES`

List downloadable file metadata for one Shodan bulk dataset. Bulk dataset access is an Enterprise feature; this action returns metadata and does not download the files.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `dataset` | string | Yes | Dataset name returned by List Datasets. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Datasets

**Slug:** `SHODAN_LIST_DATASETS`

List bulk Shodan datasets available to the connected account. Bulk data requires a Shodan Enterprise entitlement.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Network Alerts

**Slug:** `SHODAN_LIST_NETWORK_ALERTS`

List network alerts on the connected account, optionally including expired alerts. Accounts without monitoring capacity can return an empty list.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `include_expired` | boolean | No | Include expired network alerts when true. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Notifier Providers

**Slug:** `SHODAN_LIST_NOTIFIER_PROVIDERS`

List supported notification providers and the provider-specific argument names each requires.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Notifiers

**Slug:** `SHODAN_LIST_NOTIFIERS`

List notification services available on the connected account. Returned provider arguments can contain personal or secret destination data; do not log or expose them unnecessarily.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Saved Queries

**Slug:** `SHODAN_LIST_SAVED_QUERIES`

Return one page of community-saved Shodan search queries, with optional vote or timestamp ordering.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Initial 1-based page; Shodan returns 10 saved queries per page. |
| `sort` | string ("votes" | "timestamp") | No | Field used to sort saved queries. |
| `order` | string ("asc" | "desc") | No | Ascending or descending sort order. |
| `next_cursor` | string | No | Continuation cursor returned by a previous call. When supplied, it determines the next page; repeat sort and order to preserve them. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Saved Query Tags

**Slug:** `SHODAN_LIST_SAVED_QUERY_TAGS`

List the most popular tags used by community-saved Shodan queries.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `size` | integer | No | Number of popular saved-query tags to return. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Scan Protocols

**Slug:** `SHODAN_LIST_SCAN_PROTOCOLS`

List protocol names and descriptions accepted by Shodan on-demand scan requests.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Scans

**Slug:** `SHODAN_LIST_SCANS`

Return one page of active and recent on-demand scans for the connected Shodan account. Creating scans still requires credits and a paid plan.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Initial 1-based scan-list page; Shodan returns up to 100 scans per page. |
| `next_cursor` | string | No | Continuation cursor returned by a previous call; when supplied it determines the next page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Search Facets

**Slug:** `SHODAN_LIST_SEARCH_FACETS`

List facet names accepted by Shodan host search.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Search Filters

**Slug:** `SHODAN_LIST_SEARCH_FILTERS`

List filter names accepted in Shodan host-search query syntax.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove Alert Notifier

**Slug:** `SHODAN_REMOVE_ALERT_NOTIFIER`

Detach a notifier from a paid Shodan network alert so future matching events are no longer sent through it. This changes the alert's notification configuration but does not delete the notifier itself.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `alert_id` | string | Yes | Network alert id to modify. Detaching a notifier stops future matching events from being sent through it. |
| `notifier_id` | string | Yes | Notifier id to detach from the alert without deleting the notifier. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove Organization Member

**Slug:** `SHODAN_REMOVE_ORGANIZATION_MEMBER`

Permanently remove a member from the connected Shodan Enterprise organization and downgrade their account. This destructive administrative action immediately changes the user's access and entitlements and cannot be undone automatically. Verify the exact username or email address and obtain explicit authorization before calling.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `user` | string | Yes | Username or email address of the Shodan organization member to permanently remove and downgrade. Verify the exact account before calling. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Request Internet Scan

**Slug:** `SHODAN_REQUEST_INTERNET_SCAN`

Submit an Internet-wide scan for one port and protocol, initiating external network traffic and consuming scan credits. This operation is restricted to approved security researchers and Enterprise Data license holders; call it only with explicit authorization.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `port` | integer | Yes | Network port to scan across the Internet (1-65535). |
| `protocol` | string | Yes | Protocol name returned by the Shodan List Scan Protocols action. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Request Scan

**Slug:** `SHODAN_REQUEST_SCAN`

Submit an asynchronous Shodan scan for specified IP addresses or CIDR ranges. This paid operation initiates network traffic and consumes one scan credit per IP. Use it only for systems you own or have explicit authorization to assess; review the full target set before calling.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ips` | string | Yes | Targets to scan: either a comma-separated string of IP addresses or CIDR netblocks, or an object mapping each IP/netblock to [port, protocol] pairs. Only include systems you are authorized to scan. Each IP consumes one scan credit. |
| `service` | array | No | Optional services to scan, each represented exactly as [port, protocol], for example [443, 'https']. Service-restricted scans still initiate network traffic and consume scan credits. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Resolve Hostnames

**Slug:** `SHODAN_RESOLVE_HOSTNAMES`

Resolve one or more hostnames to IP addresses. Shodan Membership or higher is required. The response maps each resolved hostname to its IP address.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `hostnames` | array | Yes | One or more hostnames to resolve. Supply a list; Shodan receives it as one comma-separated query value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Reverse DNS Lookup

**Slug:** `SHODAN_REVERSE_DNS_LOOKUP`

Look up hostnames for one or more IP addresses. Shodan DNS API access requires Membership or higher.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ip_addresses` | array | Yes | IPv4 or IPv6 addresses to reverse-resolve. The list is sent as one comma-separated query value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Hosts

**Slug:** `SHODAN_SEARCH_HOSTS`

Return one page of Shodan banners matching a query, with optional facets and field selection. Filters or pages after page 1 can consume query credits and availability varies by plan.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Initial 1-based result page; each page contains up to 100 matches. |
| `query` | string | Yes | Shodan search query, including any supported filter expressions. |
| `facets` | string | No | Comma-separated facets, optionally with counts such as country:10. |
| `fields` | string | No | Comma-separated banner fields to include. |
| `minify` | boolean | No | Truncate larger fields such as http.html when true; removed fields are listed in each banner's metadata.truncated. |
| `next_cursor` | string | No | Continuation cursor returned by a previous call; when supplied it determines the next page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Saved Queries

**Slug:** `SHODAN_SEARCH_SAVED_QUERIES`

Return one page of community-saved Shodan queries matching text.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Initial 1-based page; Shodan returns 10 queries per page. |
| `query` | string | Yes | Text to search for in the saved-query directory. |
| `next_cursor` | string | No | Continuation cursor returned by a previous call; when supplied it determines the next page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Tokenize Search Query

**Slug:** `SHODAN_TOKENIZE_SEARCH_QUERY`

Parse a Shodan search query into text, filters, attributes, and syntax errors without running the search.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `query` | string | Yes | Shodan search query to parse and validate. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Unignore Alert Service

**Slug:** `SHODAN_UNIGNORE_ALERT_SERVICE`

Remove one IP:port service from a Shodan network alert trigger's ignore list so matching events can notify again. Requires a paid network alert.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `service` | string | Yes | Ignored service in IP:port form. |
| `trigger` | string | Yes | Enabled trigger name whose ignore list will change. |
| `alert_id` | string | Yes | Network alert id to modify. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Network Alert

**Slug:** `SHODAN_UPDATE_NETWORK_ALERT`

Replace the complete IP and CIDR range list monitored by an existing Shodan network alert. This changes paid monitoring coverage and may change which future matching events generate notifications; review the full replacement list before calling.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `alert_id` | string | Yes | Network alert id whose monitored IP and CIDR list will be replaced. |
| `ip_addresses` | array | Yes | Complete replacement list of IP addresses or CIDR ranges to monitor. Adding or removing coverage may change which future alert events generate notifications. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Notifier

**Slug:** `SHODAN_UPDATE_NOTIFIER`

Replace provider-specific arguments for an existing Shodan notifier. This changes where future notifications are delivered and can expose notification content to an external email address, webhook, phone number, or chat service. Verify the notifier id and every destination value before calling.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `arguments` | object | Yes | Complete provider-specific argument fields from List Notifier Providers. These values can contain private email addresses, webhook URLs, tokens, phone numbers, or chat destinations and replace where future notifications are delivered. Do not include the Shodan API key. |
| `notifier_id` | string | Yes | Notifier id to update. Do not use the account's default notifier; update only a notifier created for the intended workflow. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |
