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

# GreyNoise

GreyNoise provides cyber threat intelligence about internet-scanning IP addresses, vulnerabilities, malicious activity, business services, and workspace detections.

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

## Tools

### Acknowledge Feed Events

**Slug:** `GREYNOISE_ACKNOWLEDGE_FEED_EVENTS`

Irreversibly advance a named feed consumer's server-held checkpoint through a fetch cursor. Acknowledge only after processing the complete fetched batch: events at or before the new checkpoint will not be fetched again for this consumer. Repeating the same or an older acknowledgement is a no-op.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | Yes | Signed acknowledgement cursor returned by Fetch Feed Events after the complete batch was processed successfully. |
| `feed_id` | string | Yes | Feed UUID belonging to the authenticated workspace. |
| `consumer` | string | No | Same named consumer used to fetch the batch. Omit only when the fetch used the default consumer. |

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

### Compare Workspaces

**Slug:** `GREYNOISE_COMPARE_WORKSPACES`

Compare IPs matching a GNQL query across two workspace datasets without changing either workspace.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `size` | integer | No | Maximum records to return in this page. |
| `query` | string | Yes | GNQL query defining records to compare. |
| `next_token` | string | No | Continuation token returned by a previous comparison page. |
| `ips_from_source` | boolean | No | Return IPs from the source side of the comparison. |
| `source_workspace` | string | No | Source workspace identifier. |
| `target_workspace` | string | No | Target workspace identifier. |
| `require_both_workspaces` | boolean | No | Require records to occur in both workspaces. |

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

### Compare Workspace Stats

**Slug:** `GREYNOISE_COMPARE_WORKSPACE_STATS`

Compare aggregate GNQL statistics across two workspace datasets without changing either workspace.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `count` | integer | No | Maximum values to return per statistics facet. |
| `query` | string | Yes | GNQL query defining records to compare. |
| `source_workspace` | string | No | Source workspace identifier. |
| `target_workspace` | string | No | Target workspace identifier. |

#### 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 GNQL Results

**Slug:** `GREYNOISE_COUNT_GNQL_RESULTS`

Return the number of records matching a GNQL query without retrieving the records.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `query` | string | Yes | GNQL query string. |

#### 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 Blocklist

**Slug:** `GREYNOISE_CREATE_BLOCKLIST`

Create a persistent workspace blocklist from a GNQL query. The provider automatically refreshes its IP membership while enabled; use a disposable workspace and delete test blocklists after validation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Human-readable blocklist name. |
| `query` | string | Yes | GNQL query defining blocklist membership. |
| `enabled` | boolean | No | Whether automatic blocklist refresh is enabled. The provider defaults this to true when omitted. |
| `ip_limit` | integer | No | Maximum IP addresses retained in the blocklist. |
| `workspace_id` | string | Yes | Workspace UUID that will own the blocklist. |
| `query_workspace_id` | string | No | Workspace whose data is queried for membership. Requires the GNQL Diff entitlement when different from the owner. |

#### 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 Feed Consumer

**Slug:** `GREYNOISE_CREATE_FEED_CONSUMER`

Create persistent named consumer state at the beginning of one feed's retained history. The consumer remains until explicitly deleted and counts toward the feed's limit of 25 durable consumers.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `feed_id` | string | Yes | Feed UUID belonging to the authenticated workspace. |
| `consumer` | string | Yes | Stable name for the persistent consumer checkpoint. |

#### 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 Blocklist

**Slug:** `GREYNOISE_DELETE_BLOCKLIST`

Permanently delete one workspace blocklist, including its generated membership and access token. This cannot be undone; confirm the workspace and blocklist identifiers before calling.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `blocklist_id` | string | Yes | Blocklist UUID to permanently delete. |
| `workspace_id` | string | Yes | Owning workspace UUID. |

#### 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 Feed Consumer

**Slug:** `GREYNOISE_DELETE_FEED_CONSUMER`

Permanently delete a named event-feed consumer and all of its server-held checkpoint state. This cannot be undone; recreating the same name starts a new checkpoint at the beginning of retained history.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `feed_id` | string | Yes | Feed UUID belonging to the authenticated workspace. |
| `consumer` | string | Yes | Name of the independent server-held checkpoint to permanently delete. |

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

### Download BSI Data

**Slug:** `GREYNOISE_DOWNLOAD_BSI_DATA`

Download the licensed combined Business Service Intelligence dataset for an optional date.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `date` | string | No | Snapshot date as 'now' or YYYY-MM-DD. Historical dates return 404 when unavailable. |

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

### Download Psychic Model

**Slug:** `GREYNOISE_DOWNLOAD_PSYCHIC_MODEL`

Download a metered Psychic model for a date or inclusive date range of at most 30 days.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `date` | string | No | Daily model date as 'latest' or YYYY-MM-DD; cannot be combined with a date range. |
| `model` | string ("1" | "2" | "3" | "m1" | "m2" | "m3" | "model1" | "model2" | "model3") | Yes | Psychic model selector. |
| `format` | string ("bin" | "mmdb") | No | Download format: binary model or MaxMind DB. |
| `end_date` | string | No | Inclusive range end as YYYY-MM-DD; ranges may span at most 30 days. |
| `start_date` | string | No | Inclusive range start as YYYY-MM-DD. |

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

### Download Psychic Snapshot

**Slug:** `GREYNOISE_DOWNLOAD_PSYCHIC_SNAPSHOT`

Download a metered precomputed Psychic model snapshot for a supported lookback window.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `days` | integer ("7" | "30") | Yes | Required precomputed lookback window: 7 or 30 days. |
| `model` | string ("1" | "2" | "3" | "m1" | "m2" | "m3" | "model1" | "model2" | "model3") | Yes | Psychic model selector. |
| `format` | string ("bin" | "mmdb") | No | Download format: binary model or MaxMind DB. |

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

### Export Callback IPs

**Slug:** `GREYNOISE_EXPORT_CALLBACK_IPS`

Download a newline-delimited text file of Callback IPs matching the supplied filters.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ips` | array | No | Callback IP addresses to include. |
| `file_hash` | string | No | Filter by observed file SHA-256 hash. |
| `file_name` | string | No | Filter by observed file-name substring. |
| `file_type` | string | No | Filter by observed file MIME type. |
| `has_files` | boolean | No | Filter by whether malware files were observed. |
| `is_stage_1` | boolean | No | Filter by stage-one callback status. |
| `is_stage_2` | boolean | No | Filter by stage-two callback status. |
| `scanner_ips` | array | No | Scanner IP addresses to include. |
| `last_seen_after` | string | No | Include callbacks last seen on or after this date. |
| `first_seen_after` | string | No | Include callbacks first seen on or after this date. |
| `last_seen_before` | string | No | Include callbacks last seen on or before this date. |
| `first_seen_before` | string | No | Include callbacks first seen on or before this date. |

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

### Export GNQL IPs

**Slug:** `GREYNOISE_EXPORT_GNQL_IPS`

Download the IP addresses matching a GNQL query as a licensed export file.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `query` | string | Yes | GNQL query string. |
| `exclude_riot` | boolean | No | Exclude high-trust business-service IPs when the connected plan supports this filter. |

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

### Export Session Data

**Slug:** `GREYNOISE_EXPORT_SESSION_DATA`

Download one session in the selected PCAP or raw payload export format.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `scope` | string ("workspace" | "demo") | No | Session data scope. Export supports workspace data; demo returns 403. |
| `session_id` | string | Yes | Unique session identifier. |
| `export_type` | string ("pcap" | "rawSource" | "rawDestination") | No | Session export format. |

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

### Export Sessions PCAP

**Slug:** `GREYNOISE_EXPORT_SESSIONS_PCAP`

Download a selected page or bounded set of matching workspace sessions as a PCAP file.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `mode` | string ("page" | "all") | No | Export one page or all matches up to page_size. |
| `page` | integer | No | Page number to export when mode is page. |
| `query` | string | No | Lucene query used to filter sessions. |
| `scope` | string ("workspace" | "demo") | No | Session data scope. Export supports workspace data; demo returns 403. |
| `sort_by` | string | No | Session field used to sort results. |
| `end_time` | string | Yes | End of the query range in ISO 8601 format. |
| `page_size` | integer | No | Sessions per page, or maximum sessions when mode is all. |
| `sort_desc` | string ("true" | "false") | No | Whether to sort in descending order. |
| `start_time` | string | Yes | Start of the query range in ISO 8601 format. |

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

### Fetch Feed Events

**Slug:** `GREYNOISE_FETCH_FEED_EVENTS`

Fetch events after a named consumer's server-held checkpoint without advancing it. Repeating this read before acknowledgement can return the same events. Process the complete batch, then explicitly call Acknowledge Feed Events with the returned cursor and the same consumer name.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum events to return. |
| `feed_id` | string | Yes | Feed UUID belonging to the authenticated workspace. |
| `consumer` | string | No | Named independent server-held checkpoint to read from. |

#### 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 Blocklist

**Slug:** `GREYNOISE_GET_BLOCKLIST`

Return one workspace blocklist and its current GNQL and refresh configuration.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `blocklist_id` | string | Yes | Blocklist UUID to retrieve. |
| `workspace_id` | string | Yes | Owning workspace UUID. |

#### 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 BSI Statistics

**Slug:** `GREYNOISE_GET_BSI_STATS`

Return Business Service Intelligence statistics grouped by category, company, or trust level.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `date` | string | No | Snapshot date as 'now' or YYYY-MM-DD. Historical dates return 404 when unavailable. |
| `statistic` | string ("category" | "company" | "trust") | Yes | Dimension used to group the Business Service Intelligence statistics. |

#### 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 Callback IP

**Slug:** `GREYNOISE_GET_CALLBACK_IP`

Return Callback intelligence, scanner associations, and observed files for one IP.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ip` | string | Yes | Callback IP address to look up. |

#### 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 Callback Overview

**Slug:** `GREYNOISE_GET_CALLBACK_OVERVIEW`

Return aggregate Callback statistics for the supplied attack-stage, date, file, scanner, or IP filters.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ips` | array | No | Callback IP addresses to include. |
| `file_hash` | string | No | Filter by observed file SHA-256 hash. |
| `file_name` | string | No | Filter by observed file-name substring. |
| `file_type` | string | No | Filter by observed file MIME type. |
| `has_files` | boolean | No | Filter by whether malware files were observed. |
| `is_stage_1` | boolean | No | Filter by stage-one callback status. |
| `is_stage_2` | boolean | No | Filter by stage-two callback status. |
| `scanner_ips` | array | No | Scanner IP addresses to include. |
| `last_seen_after` | string | No | Include callbacks last seen on or after this date. |
| `first_seen_after` | string | No | Include callbacks first seen on or after this date. |
| `last_seen_before` | string | No | Include callbacks last seen on or before this date. |
| `first_seen_before` | string | No | Include callbacks first seen on or before this date. |

#### 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 Connection Plan

**Slug:** `GREYNOISE_GET_CONNECTION_PLAN`

Return the connected key's GreyNoise offering and plan for account capability discovery.

#### 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 CVE

**Slug:** `GREYNOISE_GET_CVE`

Return vulnerability, timeline, and observed exploitation intelligence for one CVE.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cve_id` | string | Yes | CVE identifier to query. |
| `include_vendors` | boolean | No | Include canonical vendors and linked products. |
| `workspace_labels` | string | No | Comma-separated dataset scopes: greynoise, community, or personal. |

#### 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 GNQL Stats

**Slug:** `GREYNOISE_GET_GNQL_STATS`

Return aggregate GNQL result counts and top values across supported facets.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `count` | integer | No | Maximum number of values returned for each aggregate facet. |
| `query` | string | Yes | GNQL query string. |

#### 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 GNQL Timeseries

**Slug:** `GREYNOISE_GET_GNQL_TIMESERIES`

Return an offset-controlled page of IP observations grouped into hourly buckets for a GNQL query, or download CSV.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `end` | string | No | RFC 3339 end timestamp for the desired range. |
| `limit` | integer | No | Maximum records to return from the backend query. |
| `query` | string | Yes | GNQL query string. |
| `start` | string | No | RFC 3339 start timestamp for the desired range. |
| `format` | string ("csv" | "json") | No | Response format. CSV responses are returned as a file. |
| `offset` | integer | No | Zero-based record offset for a JSON 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 |

### Get GNQL Timeseries Stats

**Slug:** `GREYNOISE_GET_GNQL_TIMESERIES_STATS`

Return count statistics over time for a GNQL query and RFC 3339 interval, or download CSV.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `end` | string | No | RFC 3339 end timestamp for the desired range. |
| `query` | string | Yes | GNQL query string. |
| `start` | string | No | RFC 3339 start timestamp for the desired range. |
| `format` | string ("csv" | "json") | No | Response format. CSV responses are returned as a file. |
| `interval` | string ("hour" | "day") | Yes | Time interval over which to aggregate unique IPs. |

#### 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 IP Timeline

**Slug:** `GREYNOISE_GET_IP_TIMELINE`

Return historical values for one intelligence field on an IP over a bounded number of days.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ip` | string | Yes | IPv4 address whose scanner activity timeline to retrieve. |
| `days` | string | No | Number of days to include; source_asn_subnet is limited to 90. |
| `field` | string ("destination_port" | "http_path" | "http_user_agent" | "source_asn" | "source_asn_subnet" | "source_org" | "source_rdns" | "tag_ids" | "classification") | Yes | Intelligence field to break down over time. |
| `granularity` | string | No | Bucket width in hours or days, such as 8h or 1d. |
| `workspace_labels` | string | No | Comma-separated dataset scopes: greynoise, community, or personal. |

#### 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 Private RSS Feed

**Slug:** `GREYNOISE_GET_PRIVATE_RSS_FEED`

Return the entitlement-filtered RSS 2.0 feed authorized only by the supplied opaque URL token.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `token` | string | Yes | Opaque token extracted from the issued private feed URL. |

#### 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 Private RSS URL

**Slug:** `GREYNOISE_GET_PRIVATE_RSS_URL`

Return the private RSS URL for the connected workspace, issuing one on first access if none exists.

#### 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 Public RSS Feed

**Slug:** `GREYNOISE_GET_PUBLIC_RSS_FEED`

Return the unauthenticated RSS 2.0 feed containing published community Threat Briefs.

#### 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 Session

**Slug:** `GREYNOISE_GET_SESSION`

Return one captured network session by its identifier.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `scope` | string ("workspace" | "demo") | No | Session data scope: workspace or demo. |
| `session_id` | string | Yes | Unique session identifier. |

#### 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 Session Connections

**Slug:** `GREYNOISE_GET_SESSION_CONNECTIONS`

Return a connection graph between selected source and destination session fields.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `query` | string | No | Lucene query used to filter sessions. |
| `scope` | string ("workspace" | "demo") | No | Session data scope: workspace or demo. |
| `end_time` | string | Yes | End of the query range in ISO 8601 format. |
| `max_nodes` | integer | No | Maximum number of graph nodes to return. |
| `src_field` | string | No | Source field to aggregate on. |
| `dest_field` | string | No | Destination field to aggregate on. |
| `start_time` | string | Yes | Start of the query range in ISO 8601 format. |
| `min_connections` | integer | No | Minimum connections required to include a node. |

#### 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 Session Counts

**Slug:** `GREYNOISE_GET_SESSION_COUNTS`

Return grouped session counts for selected fields, filters, and a time range.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `size` | integer | No | Number of buckets per aggregation level. |
| `query` | string | No | Lucene query used to filter sessions. |
| `scope` | string ("workspace" | "demo") | No | Session data scope: workspace or demo. |
| `fields` | string | Yes | Comma-separated fields to aggregate on. |
| `end_time` | string | Yes | End of the query range in ISO 8601 format. |
| `start_time` | string | Yes | Start of the query range in ISO 8601 format. |

#### 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 Session PCAP

**Slug:** `GREYNOISE_GET_SESSION_PCAP`

Download captured frame data for one session as a PCAP file.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `scope` | string ("workspace" | "demo") | No | Session data scope: workspace or demo. |
| `session_id` | string | Yes | Unique session identifier. |

#### 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 Session Timeseries

**Slug:** `GREYNOISE_GET_SESSION_TIMESERIES`

Return time-bucketed session counts grouped by a selected field.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `size` | integer | No | Number of groups to return when field is set. |
| `field` | string | No | Field used to group the timeseries. |
| `query` | string | No | Lucene query used to filter sessions. |
| `scope` | string ("workspace" | "demo") | No | Session data scope: workspace or demo. |
| `end_time` | string | Yes | End of the query range in ISO 8601 format. |
| `interval` | string ("auto" | "1s" | "1m" | "1h" | "1d") | No | Time interval used for bucketing. |
| `start_time` | string | Yes | Start of the query range in ISO 8601 format. |

#### 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 Session Unique Values

**Slug:** `GREYNOISE_GET_SESSION_UNIQUE_VALUES`

Download unique values, optionally with counts, for one session field as CSV.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `field` | string | Yes | Session field whose unique values to export. |
| `query` | string | No | Lucene query used to filter sessions. |
| `scope` | string ("workspace" | "demo") | No | Session data scope: workspace or demo. |
| `end_time` | string | Yes | End of the query range in ISO 8601 format. |
| `start_time` | string | Yes | Start of the query range in ISO 8601 format. |
| `include_counts` | string ("true" | "false") | No | Whether the CSV should include value counts. |

#### 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 Tactics Artifact Content

**Slug:** `GREYNOISE_GET_TACTICS_ARTIFACT_CONTENT`

Download the content of one authorized Tactics host-artifact path.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `workspace_id` | string | Yes | Workspace UUID. |
| `artifact_path` | string | Yes | Authorized host-artifact path returned by a Tactics detection. |

#### 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 Tactics Detection

**Slug:** `GREYNOISE_GET_TACTICS_DETECTION`

Return one Tactics detection with separately selected command and artifact pages.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `detection_id` | string | Yes | Detection identifier returned as session_id in detection payloads. |
| `workspace_id` | string | Yes | Workspace UUID. |
| `commands_page` | integer | No | 1-based command timeline page; each page contains up to 500 commands. |
| `artifacts_page` | integer | No | 1-based artifact path page; each page contains up to 500 paths. |

#### 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 Tag Activity

**Slug:** `GREYNOISE_GET_TAG_ACTIVITY`

Return time-bucketed activity and aggregate IP counts for one GreyNoise tag.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `days` | integer | No | Number of days of activity to retrieve. |
| `tag_id` | string | Yes | Tag UUID returned by List Tags. |
| `granularity` | string | No | Whole-hour bucket width from 1h through 168h. |
| `include_ips` | boolean | No | Include up to 1,000 source IPs in each bucket. |
| `workspace_labels` | string | No | Comma-separated dataset scopes: greynoise, community, or personal. |

#### 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 Threat Brief

**Slug:** `GREYNOISE_GET_THREAT_BRIEF`

Return one Threat Brief article by identifier.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `article_id` | string | Yes | Unique article identifier. |

#### 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 Unique IPs Job

**Slug:** `GREYNOISE_GET_UNIQUE_IPS_JOB`

Return status and one offset-controlled result page for a unique-IPs comparison job.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum unique IPs to return in this page. |
| `job_id` | string | Yes | Job ID returned by Start Unique IPs Job. |
| `offset` | integer | No | Number of unique IPs to skip on the first page. |
| `next_cursor` | string | No | Continuation cursor returned by a previous call; omit for the first 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 Blocklist IPs

**Slug:** `GREYNOISE_LIST_BLOCKLIST_IPS`

Return the current IP members generated by one workspace blocklist's GNQL query.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `size` | integer | No | Maximum IPs to return. Omit or use 0 to apply the blocklist's configured IP limit. |
| `blocklist_id` | string | Yes | Blocklist UUID whose members to return. |
| `workspace_id` | string | Yes | Owning workspace UUID. |

#### 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 Blocklists

**Slug:** `GREYNOISE_LIST_BLOCKLISTS`

Return one offset-controlled page of persistent blocklists in a GreyNoise workspace.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum blocklists to return. |
| `cursor` | string | No | Opaque continuation cursor from the preceding page. When supplied, it controls the next offset. |
| `offset` | integer | No | Number of blocklists to skip on the first page. |
| `workspace_id` | string | Yes | Workspace UUID. |

#### 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 Callback IPs

**Slug:** `GREYNOISE_LIST_CALLBACK_IPS`

Return one cursor-controlled page of Callback IPs matching attack-stage, date, file, scanner, or IP filters.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ips` | array | No | Callback IP addresses to include. |
| `page` | integer | No | Zero-based result page number for the first request. |
| `file_hash` | string | No | Filter by observed file SHA-256 hash. |
| `file_name` | string | No | Filter by observed file-name substring. |
| `file_type` | string | No | Filter by observed file MIME type. |
| `has_files` | boolean | No | Filter by whether malware files were observed. |
| `page_size` | integer | No | Number of records per page (1-1000). |
| `is_stage_1` | boolean | No | Filter by stage-one callback status. |
| `is_stage_2` | boolean | No | Filter by stage-two callback status. |
| `next_cursor` | string | No | Continuation cursor returned by a previous call; omit for the first page. |
| `scanner_ips` | array | No | Scanner IP addresses to include. |
| `last_seen_after` | string | No | Include callbacks last seen after this date. |
| `first_seen_after` | string | No | Include callbacks first seen after this date. |
| `last_seen_before` | string | No | Include callbacks last seen before this date. |
| `first_seen_before` | string | No | Include callbacks first seen before this date. |

#### 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 CVEs

**Slug:** `GREYNOISE_LIST_CVES`

Return CVE intelligence with sort, exploitability, vendor, and result-limit controls.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string ("published" | "updated" | "cvss") | No | Field by which to sort CVEs. |
| `limit` | integer | No | Maximum CVE records to return. |
| `order` | string ("desc" | "asc") | No | Sort direction. |
| `include_vendors` | boolean | No | Include canonical vendors and linked products. |
| `exploitable_only` | boolean | No | Return only CVEs whose attack vector is Network. |

#### 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 Feed Consumers

**Slug:** `GREYNOISE_LIST_FEED_CONSUMERS`

Return durable named consumers and their independent server-held checkpoint state for one event feed.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `feed_id` | string | Yes | Feed UUID belonging to the authenticated workspace. |

#### 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 GNQL Fields

**Slug:** `GREYNOISE_LIST_GNQL_FIELDS`

Return searchable GNQL field definitions, aliases, value types, and restriction flags.

#### 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 Session Fields

**Slug:** `GREYNOISE_LIST_SESSION_FIELDS`

Return fields available for querying sessions in the selected workspace or demo scope.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `scope` | string ("workspace" | "demo") | No | Session data scope: workspace or demo. |

#### 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 Sessions

**Slug:** `GREYNOISE_LIST_SESSIONS`

Return one page of sensor or demo network sessions matching a Lucene query and time range.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | First page number to request. |
| `query` | string | No | Lucene query used to filter sessions. |
| `scope` | string ("workspace" | "demo") | No | Session data scope: workspace or demo. |
| `sort_by` | string | No | Session field used to sort results. |
| `end_time` | string | Yes | End of the query range in ISO 8601 format. |
| `page_size` | integer | No | Number of sessions in this page. |
| `sort_desc` | string ("true" | "false") | No | Whether to sort in descending order. |
| `start_time` | string | Yes | Start of the query range in ISO 8601 format. |
| `next_cursor` | string | No | Continuation cursor returned by a previous page; omit for the first 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 Tactics Destination IPs

**Slug:** `GREYNOISE_LIST_TACTICS_DESTINATION_IPS`

Return one page of destination IPs associated with a Tactics detection.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor returned by a previous call; omit for the first page. |
| `page_size` | integer | No | Number of IP addresses to return per page. |
| `detection_id` | string | Yes | Detection identifier returned as session_id in detection payloads. |
| `workspace_id` | string | Yes | Workspace UUID. |
| `include_lateral` | boolean | No | Also return RFC 1918 and loopback addresses 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 Tactics Files

**Slug:** `GREYNOISE_LIST_TACTICS_FILES`

Return files associated with a Tactics detection, optionally limited to mutations.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `detection_id` | string | Yes | Detection identifier returned as session_id in detection payloads. |
| `workspace_id` | string | Yes | Workspace UUID. |
| `mutations_only` | boolean | No | Return only files created or modified by the session 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 Tags

**Slug:** `GREYNOISE_LIST_TAGS`

Return GreyNoise tag definitions filtered by name, slug, CVE, or vendor inclusion.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cve` | string | No | Filter tags by associated CVE identifier. |
| `name` | string | No | Filter tags by a partial name match. |
| `slug` | string | No | Filter tags by exact slug. |
| `include_vendors` | boolean | No | Include selected vendors and linked products. |

#### 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 Threat Brief Categories

**Slug:** `GREYNOISE_LIST_THREAT_BRIEF_CATEGORIES`

Return the available Threat Brief category definitions.

#### 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 Threat Briefs

**Slug:** `GREYNOISE_LIST_THREAT_BRIEFS`

Return a selected page of Threat Brief articles filtered and sorted by the supplied criteria.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | One-based result page number. |
| `size` | integer | No | Number of articles per page. |
| `search` | string | No | Case-insensitive search across title, subtitle, and description. |
| `sort_by` | string | No | Field to sort results by. |
| `category` | string | No | Category value to filter by. |
| `sort_desc` | string | No | Whether to sort in descending order. |

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

### Lookup BSI IP

**Slug:** `GREYNOISE_LOOKUP_BSI_IP`

Return licensed Business Service Intelligence provider matches for one IPv4 address.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ip` | string | Yes | IPv4 address to look up. |

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

### Lookup BSI IPs

**Slug:** `GREYNOISE_LOOKUP_BSI_IPS`

Return licensed Business Service Intelligence provider matches for up to 1,000 IPv4 addresses.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ips` | array | Yes | IPv4 addresses to look up in request order (maximum 1,000). |

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

### Lookup Community IP

**Slug:** `GREYNOISE_LOOKUP_COMMUNITY_IP`

Return free Community intelligence for one IP, including whether GreyNoise observed scanning or business-service activity.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ip` | string | Yes | Routable IPv4 address to query. |

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

### Lookup CVEs

**Slug:** `GREYNOISE_LOOKUP_CVES`

Return GreyNoise vulnerability and exploitation intelligence for multiple CVE identifiers.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cves` | array | Yes | CVE identifiers to look up, with at most 10,000 entries. |
| `include_vendors` | boolean | No | Include canonical vendors and linked products. |

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

### Lookup IP

**Slug:** `GREYNOISE_LOOKUP_IP`

Return full or quick scanner and business-service intelligence for one IP, subject to workspace entitlements.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ip` | string | Yes | IP address to query. |
| `quick` | boolean | No | Return only the IP and classification or trust level when true. |
| `workspace_labels` | string | No | Comma-separated dataset scopes to query: greynoise, community, or personal. |

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

### Lookup IPs

**Slug:** `GREYNOISE_LOOKUP_IPS`

Return scanner and business-service intelligence for up to 10,000 IPs in one read-only lookup.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ips` | array | Yes | IPv4 addresses to look up, with at most 10,000 entries. |
| `quick` | boolean | No | Return only each IP and its classification or trust level when true. |
| `workspace_labels` | string | No | Comma-separated dataset scopes to query: greynoise, community, or personal. |

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

### Reset Feed Consumer

**Slug:** `GREYNOISE_RESET_FEED_CONSUMER`

Irreversibly reset a named consumer checkpoint to the beginning of currently retained feed history. The next fetch can redeliver events this consumer already processed.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `feed_id` | string | Yes | Feed UUID belonging to the authenticated workspace. |
| `consumer` | string | Yes | Name of the independent server-held checkpoint to reset. |

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

### Rotate Private RSS URL

**Slug:** `GREYNOISE_ROTATE_PRIVATE_RSS_URL`

Rotate the workspace's private RSS URL and immediately invalidate the previous URL.

#### 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 Feed Events

**Slug:** `GREYNOISE_SEARCH_FEED_EVENTS`

Search retained event-feed history without reading or changing any named consumer's server-held checkpoint. Returns one newest-first page.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ip` | string | No | Exact IP address to match. |
| `cve` | string | No | Exact CVE identifier to match. |
| `tag` | string | No | Exact GreyNoise tag to match. |
| `limit` | integer | No | Maximum events to return on this page. |
| `cursor` | string | No | Opaque cursor from the previous search page. With a cursor, omit all filters; only limit may also be supplied. |
| `to_time` | string | No | Exclusive end as a UTC date or RFC 3339 timestamp. Defaults to request time. |
| `feed_ids` | array | No | Feed UUIDs to include. Omit to search all enabled non-session feeds. |
| `from_time` | string | No | Inclusive start as a positive hour/day duration, UTC date, or RFC 3339 timestamp. Defaults to one hour before the end. |
| `event_types` | array | No | Exact retained event types to include. |
| `classification` | string | No | Exact classification to match. |

#### 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 GNQL

**Slug:** `GREYNOISE_SEARCH_GNQL`

Search GreyNoise intelligence with GNQL and return one cursor-controlled page or a CSV file.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `size` | integer | No | Results to return on this page. |
| `query` | string | Yes | GNQL query string. |
| `quick` | boolean | No | Return only IP, classification, or trust level when true. |
| `cursor` | string | No | Continuation cursor returned by a previous JSON search page. |
| `format` | string ("csv" | "json") | No | Response format. CSV responses are returned as a file. |
| `exclude` | string | No | Comma-separated response fields to exclude. |

#### 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 GNQL Metadata

**Slug:** `GREYNOISE_SEARCH_GNQL_METADATA`

Search GNQL metadata and return one cursor-controlled page without raw scan data.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `size` | integer | No | Results to return on this page. |
| `query` | string | Yes | GNQL query string. |
| `quick` | boolean | No | Return only IP, classification, or trust level when true. |
| `cursor` | string | No | Continuation cursor returned by a previous metadata search page. |
| `exclude` | string | No | Comma-separated additional response fields to exclude. |

#### 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 Tactics Detections

**Slug:** `GREYNOISE_SEARCH_TACTICS_DETECTIONS`

Search workspace Tactics detections and return one cursor-controlled page.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ip` | string | No | IP address associated with the detection. |
| `rules` | array | No | Rule names to include. |
| `cursor` | string | No | Opaque continuation cursor returned by a previous call; omit for the first page. |
| `tactics` | array | No | MITRE ATT&CK tactics to include. |
| `end_time` | string | No | Latest detection time in RFC 3339 format. |
| `page_size` | integer | No | Number of detections to return per page. |
| `sensor_id` | string | No | Sensor UUID filter. |
| `profile_id` | string | No | Profile UUID filter. |
| `start_time` | string | No | Earliest detection time in RFC 3339 format. |
| `techniques` | array | No | MITRE ATT&CK techniques to include. |
| `any_process` | string | No | Value to match at any process level. |
| `process_name` | string | No | Exact process name filter. |
| `workspace_id` | string | Yes | Workspace UUID. |
| `process_parent` | string | No | Parent process filter. |
| `process_grandparent` | string | No | Grandparent process filter. |
| `profile_instance_id` | string | No | Profile instance UUID filter. |
| `exclude_non_interactive` | boolean | No | Return only interactive sessions when true. |
| `process_great_grandparent` | string | No | Great-grandparent process filter. |

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

### Start Unique IPs Job

**Slug:** `GREYNOISE_START_UNIQUE_IPS_JOB`

Start an asynchronous job that finds IPs unique to one of two workspace datasets.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `query` | string | Yes | GNQL query used to calculate unique IPs. |
| `source_workspace` | string | No | Source workspace identifier. |
| `target_workspace` | string | No | Target workspace identifier. |

#### 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 Blocklist

**Slug:** `GREYNOISE_UPDATE_BLOCKLIST`

Replace a persistent blocklist's GNQL query and configurable settings in place. Changing the query, IP limit, query workspace, or enabled state can change the addresses distributed by the blocklist.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Replacement human-readable name. |
| `query` | string | Yes | Replacement GNQL query defining blocklist membership. |
| `enabled` | boolean | No | Whether automatic blocklist refresh is enabled. |
| `ip_limit` | integer | No | Replacement maximum IP count. |
| `blocklist_id` | string | Yes | Blocklist UUID to replace in place. |
| `workspace_id` | string | Yes | Owning workspace UUID. |
| `query_workspace_id` | string | No | Replacement workspace whose data is queried. Requires GNQL Diff when different from the owner. |

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

### Validate GNQL Query

**Slug:** `GREYNOISE_VALIDATE_GNQL_QUERY`

Validate a GNQL query and return its adjusted form without running the search.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `query` | string | Yes | GNQL query to validate without executing it. |
| `report_unknown_tags` | boolean | No | Report exact tag values that are unknown to the workspace. |

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