Panther

App · 24 actions

Work your Panther alerts from workflows: triage, assign and comment on them, run SQL and indicator searches over your security logs, turn detections on or off, and check log source health. Start a workflow when an alert fires, changes status or is assigned, a log source goes quiet, or a scheduled query finishes.

Actions

ActionWhat it does
Add alert commentAdd a comment to an alert, shown in its activity in Panther.
Assign alertAssign an alert to someone in Panther, picked from the list or named by their email.
Create saved querySave a SQL query in Panther under a name, for people to run in the console and workflows to run with 'Run saved query'.
Delete saved queryDelete a saved query from Panther.
Get alertGet an alert's details: its title, severity, status, detection, assignee, runbook and alert context.
Get detectionGet a detection's details: whether it's on, its severity, description, runbook, tags and log types.
Get log sourceGet a log source's health, its log types and when it last sent logs.
Get metricsGet how many alerts there were by severity and detection, and how many log events and bytes Panther processed by log type, over a period.
Get query resultsGet the rows of a query started earlier, waiting while it runs, or the next page of a finished query's rows.
List alert commentsList an alert's comments with who wrote each and when.
List alert eventsList the log events behind an alert, as Panther stored them.
List alertsList alerts by status, severity, when they were created, detection, title or assignee, newest first.
List detectionsList rules, scheduled rules, simple rules, correlation rules or policies, by whether they're on, severity, name or tag.
List log sourcesList the log sources sending data to Panther, with whether each is healthy and when it last sent logs.
List rolesList Panther's roles and the permissions each gives.
List saved queriesList the queries saved in Panther, with their SQL and schedules.
List usersList the people who use Panther, with their roles and when they last signed in.
Run queryRun a SQL query over your logs in Panther's data lake and wait up to 5 minutes for the rows.
Run saved queryRun a saved query and wait up to 5 minutes for its rows.
Search logs for indicatorsSearch every log for IP addresses, domains, emails, hashes or other indicators over a period, and wait up to 5 minutes for the matching rows.
Start queryStart a SQL query over your logs and carry on at once.
Turn detection on or offTurn a detection on or off.
Unassign alertTake an alert's assignee off it, so it shows as unassigned.
Update alertChange an alert's status, rate its quality as Useful or Noise, or add context tags.

Add alert comment

Add a comment to an alert, shown in its activity in Panther.

Inputs

Alertalert_idtextRequired
The alert's ID, from a Panther trigger or 'List alerts', or a link to the alert in Panther.
CommentcommenttextRequired
What the comment says.
Formattext_formattext
Plain text, or HTML for links and formatting. Leave blank for plain text.One of: PLAIN_TEXT (Plain text), HTML.

Outputs

alert_idtext
The alert it's on
author_emailtext
The writer's email, when it's a user
author_idtext
The ID of who wrote it
author_nametext
The writer's name, when it's a user
author_typetext
user, api-token or system
bodytext
What it says
created_attext
When it was written (ISO 8601)
formattext
PLAIN_TEXT or HTML
idtext
The comment's ID
updated_attext
When it was last changed (ISO 8601)
Example output
{
  "alert_id": "b90c19e66e160e194a5b3b94ec27fb7c",
  "author_email": "ada@example.com",
  "author_id": "8a1d2c0e-5b6f-4a7c-9d8e-0f1a2b3c4d5e",
  "author_name": "Ada Lovelace",
  "author_type": "user",
  "body": "Checked with the network team: this is a known scanner.",
  "created_at": "2026-11-05T04:02:10Z",
  "format": "PLAIN_TEXT",
  "id": "3c9f7e2a-1b4d-4e8f-a6c5-7d2e9f0b1a3c",
  "updated_at": "2026-11-05T04:02:10Z"
}

Assign alert

Assign an alert to someone in Panther, picked from the list or named by their email.

Inputs

Alertalert_idtextRequired
The alert's ID, from a Panther trigger or 'List alerts', or a link to the alert in Panther.
AssigneeassigneetextRequired
Who to assign it to, picked or typed as their email.

Outputs

assignee_emailtext
Their email; empty if unassigned or unknown
assignee_idtext
The ID of the user it's assigned to; empty if unassigned
assignee_nametext
Their name; empty if unassigned or unknown
contextobject
The alert context its detection added, as Panther gives it
context_tagslist
Its context tags
created_attext
When the alert was created (ISO 8601)
detection_idtext
The ID of the detection that raised it
detection_typetext
RULE, SCHEDULED_RULE, CORRELATION_RULE or POLICY
event_countnumber
How many events it has
first_event_attext
When its first event happened (ISO 8601)
idtext
The alert's ID
last_event_attext
When its latest event arrived (ISO 8601)
linktext
A link to the alert in Panther; empty for an instance outside Panther's cloud
qualitytext
USEFUL or NOISE; empty if not rated
runbooktext
What to do about it, from its detection
severitytext
CRITICAL, HIGH, MEDIUM, LOW or INFO
statustext
OPEN, TRIAGED, RESOLVED or CLOSED (shown as Invalid in Panther)
status_labeltext
The status as Panther shows it: Open, Triaged, Resolved or Invalid
system_error_source_idtext
For a system error, the ID of what it's about
system_error_source_typetext
For a system error, what kind of thing that is
system_error_typetext
For a system error, what kind it is
titletext
The alert's title
typetext
What raised it, such as RULE, SCHEDULED_RULE or POLICY
Example output
{
  "assignee_email": "ada@example.com",
  "assignee_id": "8a1d2c0e-5b6f-4a7c-9d8e-0f1a2b3c4d5e",
  "assignee_name": "Ada Lovelace",
  "context": {
    "ip": "123.123.123.123"
  },
  "context_tags": [],
  "created_at": "2026-11-05T03:35:24Z",
  "detection_id": "AllLogs.IPMonitoring",
  "detection_type": "RULE",
  "event_count": 3,
  "first_event_at": "2026-11-05T03:31:02Z",
  "id": "b90c19e66e160e194a5b3b94ec27fb7c",
  "last_event_at": "2026-11-05T03:35:20Z",
  "link": "https://acme.runpanther.net/alerts/b90c19e66e160e194a5b3b94ec27fb7c",
  "quality": "",
  "runbook": "Check whether the address belongs to a vendor before blocking it.",
  "severity": "HIGH",
  "status": "OPEN",
  "status_label": "Open",
  "system_error_source_id": "",
  "system_error_source_type": "",
  "system_error_type": "",
  "title": "New Alert: Suspicious traffic detected from [123.123.123.123]",
  "type": "RULE"
}

Create saved query

Save a SQL query in Panther under a name, for people to run in the console and workflows to run with 'Run saved query'.

Inputs

NamenametextRequired
What to call it. Names must be unique.
SQLsqltextRequired
The SQL to run over your logs, such as select * from panther_logs.public.aws_cloudtrail where p_occurs_since('1 day') limit 100.
Descriptiondescriptiontext
What the query is for.

Outputs

created_attext
When it was saved (ISO 8601)
crontext
Its schedule as a cron expression; empty if none
descriptiontext
What it's for
idtext
The saved query's ID
managedtrue/false
True if Panther manages it
nametext
Its name
rate_minutesnumber
How often it runs, in minutes; 0 if not set
scheduledtrue/false
True if it runs on a schedule
sqltext
Its SQL
updated_attext
When it last changed (ISO 8601)
Example output
{
  "created_at": "2026-10-01T09:00:00Z",
  "cron": "",
  "description": "Inbound SSH from addresses outside the office",
  "id": "6f1e2d3c-4b5a-4968-8776-a5b4c3d2e1f0",
  "managed": false,
  "name": "SSH from outside",
  "rate_minutes": 0,
  "scheduled": false,
  "sql": "select p_event_time, srcAddr, dstPort from panther_logs.public.aws_vpcflow where p_occurs_since('1 day') limit 50",
  "updated_at": "2026-10-01T09:00:00Z"
}

Delete saved query

Delete a saved query from Panther. This can't be undone.

Inputs

Saved querysaved_querytextRequired
The saved query, picked from the list or given as its ID from another step.

Outputs

deletedtrue/false
True once deleted
idtext
The saved query's ID
Example output
{
  "deleted": true,
  "id": "6f1e2d3c-4b5a-4968-8776-a5b4c3d2e1f0"
}

Get alert

Get an alert's details: its title, severity, status, detection, assignee, runbook and alert context.

Inputs

Alertalert_idtextRequired
The alert's ID, from a Panther trigger or 'List alerts', or a link to the alert in Panther.

Outputs

assignee_emailtext
Their email; empty if unassigned or unknown
assignee_idtext
The ID of the user it's assigned to; empty if unassigned
assignee_nametext
Their name; empty if unassigned or unknown
contextobject
The alert context its detection added, as Panther gives it
context_tagslist
Its context tags
created_attext
When the alert was created (ISO 8601)
detection_idtext
The ID of the detection that raised it
detection_typetext
RULE, SCHEDULED_RULE, CORRELATION_RULE or POLICY
event_countnumber
How many events it has
first_event_attext
When its first event happened (ISO 8601)
idtext
The alert's ID
last_event_attext
When its latest event arrived (ISO 8601)
linktext
A link to the alert in Panther; empty for an instance outside Panther's cloud
qualitytext
USEFUL or NOISE; empty if not rated
runbooktext
What to do about it, from its detection
severitytext
CRITICAL, HIGH, MEDIUM, LOW or INFO
statustext
OPEN, TRIAGED, RESOLVED or CLOSED (shown as Invalid in Panther)
status_labeltext
The status as Panther shows it: Open, Triaged, Resolved or Invalid
system_error_source_idtext
For a system error, the ID of what it's about
system_error_source_typetext
For a system error, what kind of thing that is
system_error_typetext
For a system error, what kind it is
titletext
The alert's title
typetext
What raised it, such as RULE, SCHEDULED_RULE or POLICY
Example output
{
  "assignee_email": "ada@example.com",
  "assignee_id": "8a1d2c0e-5b6f-4a7c-9d8e-0f1a2b3c4d5e",
  "assignee_name": "Ada Lovelace",
  "context": {
    "ip": "123.123.123.123"
  },
  "context_tags": [],
  "created_at": "2026-11-05T03:35:24Z",
  "detection_id": "AllLogs.IPMonitoring",
  "detection_type": "RULE",
  "event_count": 3,
  "first_event_at": "2026-11-05T03:31:02Z",
  "id": "b90c19e66e160e194a5b3b94ec27fb7c",
  "last_event_at": "2026-11-05T03:35:20Z",
  "link": "https://acme.runpanther.net/alerts/b90c19e66e160e194a5b3b94ec27fb7c",
  "quality": "",
  "runbook": "Check whether the address belongs to a vendor before blocking it.",
  "severity": "HIGH",
  "status": "OPEN",
  "status_label": "Open",
  "system_error_source_id": "",
  "system_error_source_type": "",
  "system_error_type": "",
  "title": "New Alert: Suspicious traffic detected from [123.123.123.123]",
  "type": "RULE"
}

Get detection

Get a detection's details: whether it's on, its severity, description, runbook, tags and log types.

Inputs

Detection typedetection_typetext
What kind of detection it is. Leave blank for a rule.One of: rule, scheduled_rule (Scheduled rule), simple_rule (Simple rule), correlation_rule (Correlation rule), policy.
DetectiondetectiontextRequired
The detection, picked from the list or typed as its ID, such as AWS.CloudTrail.Created.

Outputs

created_attext
When it was created (ISO 8601)
dedup_minutesnumber
For how many minutes matching events join one alert
descriptiontext
What it looks for
enabledtrue/false
True if it's on
idtext
The detection's ID
last_modifiedtext
When it last changed (ISO 8601)
log_typeslist
The log types it reads; empty for a policy
managedtrue/false
True if Panther manages it
nametext
Its display name, or its ID if it has none
referencetext
A link or note for more about it
resource_typeslist
For a policy, the cloud resource types it checks
runbooktext
What to do about its alerts
scheduled_querieslist
For a scheduled rule, the saved queries it reads
severitytext
CRITICAL, HIGH, MEDIUM, LOW or INFO
tagslist
Its tags
thresholdnumber
How many events must match before it alerts; 0 if not set
typetext
rule, scheduled_rule, simple_rule, correlation_rule or policy
Example output
{
  "created_at": "2026-10-01T09:00:00Z",
  "dedup_minutes": 60,
  "description": "This rule alerts on any activity outside of our IP address allowlist",
  "enabled": true,
  "id": "AllLogs.IPMonitoring",
  "last_modified": "2026-11-01T12:00:00Z",
  "log_types": [
    "AWS.VPCFlow"
  ],
  "managed": false,
  "name": "Monitor Suspicious IPs",
  "reference": "https://docs.panther.com/detections/rules",
  "resource_types": [],
  "runbook": "Check whether the address belongs to a vendor before blocking it.",
  "scheduled_queries": [],
  "severity": "HIGH",
  "tags": [
    "Network Monitoring",
    "Threat Intel"
  ],
  "threshold": 1,
  "type": "rule"
}

Get log source

Get a log source's health, its log types and when it last sent logs.

Inputs

Log sourcelog_sourcetextRequired
The log source, picked from the list or given as its ID.

Outputs

created_attext
When it was added (ISO 8601)
editabletrue/false
True if it can be changed
healthytrue/false
True if Panther says it's healthy
idtext
The log source's ID
last_event_processed_attext
When Panther last processed its logs (ISO 8601)
last_event_received_attext
When it last sent logs (ISO 8601); empty if never
last_modifiedtext
When it last changed (ISO 8601)
log_typeslist
The log types it brings in
nametext
Its name
typetext
What kind it is, such as aws-s3
Example output
{
  "created_at": "2026-06-01T10:00:00Z",
  "editable": true,
  "healthy": true,
  "id": "bcd45662-bab7-4f99-b69f-083a0212568d",
  "last_event_processed_at": "2026-11-05T08:59:40Z",
  "last_event_received_at": "2026-11-05T08:59:12Z",
  "last_modified": "2026-09-14T15:30:00Z",
  "log_types": [
    "AWS.VPCFlow"
  ],
  "name": "Production VPC flow logs",
  "type": "aws-s3"
}

Get metrics

Get how many alerts there were by severity and detection, and how many log events and bytes Panther processed by log type, over a period.

Inputs

Fromfrom_timedate and time
The start of the period. Leave blank for 7 days before To.
Toto_timedate and time
The end of the period. Leave blank for now.

Outputs

alerts_by_detectionlist
Alerts per detection
alerts_by_severitylist
Alerts per severity
bytes_by_log_typelist
Data processed per log type
events_by_log_typelist
Events processed per log type
from_timetext
The start of the period (ISO 8601)
to_timetext
The end of the period (ISO 8601)
total_alertsnumber
How many alerts there were
total_bytes_processednumber
How much log data Panther processed, in bytes
total_bytes_queriednumber
How much data queries scanned, in bytes
total_events_processednumber
How many log events Panther processed
Example output
{
  "alerts_by_detection": [
    {
      "count": 12,
      "detection_id": "AllLogs.IPMonitoring",
      "detection_name": "Monitor Suspicious IPs"
    }
  ],
  "alerts_by_severity": [
    {
      "count": 12,
      "severity": "HIGH"
    },
    {
      "count": 30,
      "severity": "MEDIUM"
    }
  ],
  "bytes_by_log_type": [
    {
      "bytes": 9663676416,
      "log_type": "AWS.VPCFlow"
    }
  ],
  "events_by_log_type": [
    {
      "events": 18250000,
      "log_type": "AWS.VPCFlow"
    }
  ],
  "from_time": "2026-10-29T09:00:00.000Z",
  "to_time": "2026-11-05T09:00:00.000Z",
  "total_alerts": 42,
  "total_bytes_processed": 9663676416,
  "total_bytes_queried": 1073741824,
  "total_events_processed": 18250000
}

Get query results

Get the rows of a query started earlier, waiting while it runs, or the next page of a finished query's rows.

Inputs

Query IDquery_idtextRequired
The query ID from 'Start query', 'Run query' or a scheduled query trigger.
Rowsmax_rowsnumber
The most rows to return on one page, up to 999. Defaults to 100.From 1 to 999.
Next pagecursortext
The 'next_cursor' from the query's last page, for the rows after it.

Outputs

bytes_scannednumber
How much data the query scanned, in bytes
columnslist
The columns, in order
completed_attext
When it finished (ISO 8601)
execution_msnumber
How long it ran, in milliseconds
has_moretrue/false
True if there are more rows to fetch
next_cursortext
Give this to 'Get query results' as 'Next page' for more rows; empty on the last page
query_idtext
The query's ID in Panther
row_countnumber
How many rows are on this page
rowslist
The rows on this page, each by column name
sqltext
The SQL that ran
started_attext
When it started (ISO 8601)
statustext
succeeded once it has finished
total_rowsnumber
How many rows the query returned in all
Example output
{
  "bytes_scanned": 1048576,
  "columns": [
    "p_event_time",
    "srcAddr",
    "dstPort"
  ],
  "completed_at": "2026-11-05T09:00:02Z",
  "execution_ms": 1840,
  "has_more": false,
  "next_cursor": "",
  "query_id": "01b8c2d4-0306-7a1f-0000-4d5e6f708192",
  "row_count": 1,
  "rows": [
    {
      "dstPort": 22,
      "p_event_time": "2026-11-05 03:31:02.000",
      "srcAddr": "123.123.123.123"
    }
  ],
  "sql": "select p_event_time, srcAddr, dstPort from panther_logs.public.aws_vpcflow where p_occurs_since('1 day') limit 50",
  "started_at": "2026-11-05T09:00:00Z",
  "status": "succeeded",
  "total_rows": 1
}

List alert comments

List an alert's comments with who wrote each and when.

Inputs

Alertalert_idtextRequired
The alert's ID, from a Panther trigger or 'List alerts', or a link to the alert in Panther.
How manylimitnumber
The most to list on one page, up to 50. Defaults to 25.From 1 to 50.
Next pagecursortext
The 'next_cursor' from an earlier page of this list, for the page after it.

Outputs

commentslist
The alert's comments
countnumber
How many are on this page
next_cursortext
Give this as 'Next page' to get the next page; empty on the last
Example output
{
  "comments": [
    {
      "alert_id": "b90c19e66e160e194a5b3b94ec27fb7c",
      "author_email": "ada@example.com",
      "author_id": "8a1d2c0e-5b6f-4a7c-9d8e-0f1a2b3c4d5e",
      "author_name": "Ada Lovelace",
      "author_type": "user",
      "body": "Checked with the network team: this is a known scanner.",
      "created_at": "2026-11-05T04:02:10Z",
      "format": "PLAIN_TEXT",
      "id": "3c9f7e2a-1b4d-4e8f-a6c5-7d2e9f0b1a3c",
      "updated_at": "2026-11-05T04:02:10Z"
    }
  ],
  "count": 1,
  "next_cursor": ""
}

List alert events

List the log events behind an alert, as Panther stored them.

Inputs

Alertalert_idtextRequired
The alert's ID, from a Panther trigger or 'List alerts', or a link to the alert in Panther.
How manylimitnumber
The most to list on one page, up to 50. Defaults to 25.From 1 to 50.
Next pagecursortext
The 'next_cursor' from an earlier page of this list, for the page after it.

Outputs

countnumber
How many are on this page
eventslist
The log events, as Panther stored them
next_cursortext
Give this as 'Next page' to get the next page; empty on the last
Example output
{
  "count": 1,
  "events": [
    {
      "dstPort": 22,
      "p_event_time": "2026-11-05 03:31:02.000",
      "p_log_type": "AWS.VPCFlow",
      "srcAddr": "123.123.123.123"
    }
  ],
  "next_cursor": ""
}

List alerts

List alerts by status, severity, when they were created, detection, title or assignee, newest first. Without dates, Panther lists the last 30 days.

Inputs

Kindalert_typetext
Alerts from detections, or Panther's detection or system errors. Leave blank for alerts.One of: ALERT (Alerts), DETECTION_ERROR (Detection errors), SYSTEM_ERROR (System errors).
Statusesstatuseslist
Only alerts with one of these statuses. Leave blank for every status.One or more of: OPEN, TRIAGED, RESOLVED, CLOSED (Invalid).
Severitiesseveritieslist
Only these severities. Leave blank for every severity.One or more of: CRITICAL, HIGH, MEDIUM, LOW, INFO.
Created aftercreated_afterdate and time
Only alerts created after this.
Created beforecreated_beforedate and time
Only alerts created before this.
Detectiondetectiontext
Only alerts from this detection, picked or typed as its ID.
Title containstitle_containstext
Only alerts whose title has this.
Assigneeassigneetext
Only alerts assigned to this person, picked or typed as their email.
Orderordertext
Newest or oldest first. Leave blank for newest first.One of: desc (Newest first), asc (Oldest first).
How manylimitnumber
The most to list on one page, up to 50. Defaults to 25.From 1 to 50.
Next pagecursortext
The 'next_cursor' from an earlier page of this list, for the page after it.

Outputs

alertslist
The alerts found
countnumber
How many are on this page
next_cursortext
Give this as 'Next page' to get the next page; empty on the last
Example output
{
  "alerts": [
    {
      "assignee_email": "ada@example.com",
      "assignee_id": "8a1d2c0e-5b6f-4a7c-9d8e-0f1a2b3c4d5e",
      "assignee_name": "Ada Lovelace",
      "context": {
        "ip": "123.123.123.123"
      },
      "context_tags": [],
      "created_at": "2026-11-05T03:35:24Z",
      "detection_id": "AllLogs.IPMonitoring",
      "detection_type": "RULE",
      "event_count": 3,
      "first_event_at": "2026-11-05T03:31:02Z",
      "id": "b90c19e66e160e194a5b3b94ec27fb7c",
      "last_event_at": "2026-11-05T03:35:20Z",
      "link": "https://acme.runpanther.net/alerts/b90c19e66e160e194a5b3b94ec27fb7c",
      "quality": "",
      "runbook": "Check whether the address belongs to a vendor before blocking it.",
      "severity": "HIGH",
      "status": "OPEN",
      "status_label": "Open",
      "system_error_source_id": "",
      "system_error_source_type": "",
      "system_error_type": "",
      "title": "New Alert: Suspicious traffic detected from [123.123.123.123]",
      "type": "RULE"
    }
  ],
  "count": 1,
  "next_cursor": ""
}

List detections

List rules, scheduled rules, simple rules, correlation rules or policies, by whether they're on, severity, name or tag.

Inputs

Detection typedetection_typetext
Which kind of detection to list. Leave blank for rules.One of: rule, scheduled_rule (Scheduled rule), simple_rule (Simple rule), correlation_rule (Correlation rule), policy.
On or offstatetext
Only detections that are on, or off. Leave blank for both.One of: enabled (On), disabled (Off).
Severitiesseveritieslist
Only these severities. Leave blank for every severity.One or more of: CRITICAL, HIGH, MEDIUM, LOW, INFO.
Name containsname_containstext
Only detections whose name has this.
Tagtagtext
Only detections with this tag.
How manylimitnumber
The most to list on one page, up to 100. Defaults to 25.From 1 to 100.
Next pagecursortext
The 'next_cursor' from an earlier page of this list, for the page after it.

Outputs

countnumber
How many are on this page
detectionslist
The detections found
next_cursortext
Give this as 'Next page' to get the next page; empty on the last
Example output
{
  "count": 1,
  "detections": [
    {
      "created_at": "2026-10-01T09:00:00Z",
      "dedup_minutes": 60,
      "description": "This rule alerts on any activity outside of our IP address allowlist",
      "enabled": true,
      "id": "AllLogs.IPMonitoring",
      "last_modified": "2026-11-01T12:00:00Z",
      "log_types": [
        "AWS.VPCFlow"
      ],
      "managed": false,
      "name": "Monitor Suspicious IPs",
      "reference": "https://docs.panther.com/detections/rules",
      "resource_types": [],
      "runbook": "Check whether the address belongs to a vendor before blocking it.",
      "scheduled_queries": [],
      "severity": "HIGH",
      "tags": [
        "Network Monitoring",
        "Threat Intel"
      ],
      "threshold": 1,
      "type": "rule"
    }
  ],
  "next_cursor": ""
}

List log sources

List the log sources sending data to Panther, with whether each is healthy and when it last sent logs.

Inputs

Only unhealthyunhealthy_onlytrue/false
Turn on to list only the log sources Panther says are unhealthy.

Outputs

countnumber
How many
sourceslist
The log sources
Example output
{
  "count": 1,
  "sources": [
    {
      "created_at": "2026-06-01T10:00:00Z",
      "editable": true,
      "healthy": true,
      "id": "bcd45662-bab7-4f99-b69f-083a0212568d",
      "last_event_processed_at": "2026-11-05T08:59:40Z",
      "last_event_received_at": "2026-11-05T08:59:12Z",
      "last_modified": "2026-09-14T15:30:00Z",
      "log_types": [
        "AWS.VPCFlow"
      ],
      "name": "Production VPC flow logs",
      "type": "aws-s3"
    }
  ]
}

List roles

List Panther's roles and the permissions each gives.

Inputs

Name containsname_containstext
Only roles whose name has this.

Outputs

countnumber
How many
roleslist
The roles
Example output
{
  "count": 1,
  "roles": [
    {
      "created_at": "2026-01-10T09:00:00Z",
      "id": "2f6e8d1c-0a3b-4c5d-8e7f-9a0b1c2d3e4f",
      "log_type_access": [],
      "log_type_access_kind": "ALLOW_ALL",
      "name": "Analyst",
      "permissions": [
        "AlertRead",
        "AlertModify",
        "DataAnalyticsRead"
      ],
      "updated_at": "2026-03-02T11:00:00Z"
    }
  ]
}

List saved queries

List the queries saved in Panther, with their SQL and schedules.

Inputs

How manylimitnumber
The most to list on one page, up to 100. Defaults to 25.From 1 to 100.
Next pagecursortext
The 'next_cursor' from an earlier page of this list, for the page after it.

Outputs

countnumber
How many are on this page
next_cursortext
Give this as 'Next page' to get the next page; empty on the last
querieslist
The saved queries
Example output
{
  "count": 1,
  "next_cursor": "",
  "queries": [
    {
      "created_at": "2026-10-01T09:00:00Z",
      "cron": "",
      "description": "Inbound SSH from addresses outside the office",
      "id": "6f1e2d3c-4b5a-4968-8776-a5b4c3d2e1f0",
      "managed": false,
      "name": "SSH from outside",
      "rate_minutes": 0,
      "scheduled": false,
      "sql": "select p_event_time, srcAddr, dstPort from panther_logs.public.aws_vpcflow where p_occurs_since('1 day') limit 50",
      "updated_at": "2026-10-01T09:00:00Z"
    }
  ]
}

List users

List the people who use Panther, with their roles and when they last signed in.

Inputs

Name or emailsearchtext
Only people whose name or email has this.
Include deactivatedinclude_deactivatedtrue/false
Turn on to list deactivated people too.
How manylimitnumber
The most to list on one page, up to 60. Defaults to 25.From 1 to 60.
Next pagecursortext
The 'next_cursor' from an earlier page of this list, for the page after it.

Outputs

countnumber
How many are on this page
next_cursortext
Give this as 'Next page' to get the next page; empty on the last
userslist
The users found
Example output
{
  "count": 1,
  "next_cursor": "",
  "users": [
    {
      "created_at": "2026-01-10T09:00:00Z",
      "email": "ada@example.com",
      "enabled": true,
      "first_name": "Ada",
      "id": "8a1d2c0e-5b6f-4a7c-9d8e-0f1a2b3c4d5e",
      "last_logged_in_at": "2026-11-05T08:00:00Z",
      "last_name": "Lovelace",
      "name": "Ada Lovelace",
      "role_id": "2f6e8d1c-0a3b-4c5d-8e7f-9a0b1c2d3e4f",
      "role_name": "Analyst",
      "status": "CONFIRMED"
    }
  ]
}

Run query

Run a SQL query over your logs in Panther's data lake and wait up to 5 minutes for the rows. For a longer query, use 'Start query' and 'Get query results'.

Inputs

SQLsqltextRequired
The SQL to run over your logs, such as select * from panther_logs.public.aws_cloudtrail where p_occurs_since('1 day') limit 100.
Databasedatabasetext
The database the query's tables are in. Leave blank for Panther's logs database, or name each table in full.
Rowsmax_rowsnumber
The most rows to return on one page, up to 999. Defaults to 100.From 1 to 999.

Outputs

bytes_scannednumber
How much data the query scanned, in bytes
columnslist
The columns, in order
completed_attext
When it finished (ISO 8601)
execution_msnumber
How long it ran, in milliseconds
has_moretrue/false
True if there are more rows to fetch
next_cursortext
Give this to 'Get query results' as 'Next page' for more rows; empty on the last page
query_idtext
The query's ID in Panther
row_countnumber
How many rows are on this page
rowslist
The rows on this page, each by column name
sqltext
The SQL that ran
started_attext
When it started (ISO 8601)
statustext
succeeded once it has finished
total_rowsnumber
How many rows the query returned in all
Example output
{
  "bytes_scanned": 1048576,
  "columns": [
    "p_event_time",
    "srcAddr",
    "dstPort"
  ],
  "completed_at": "2026-11-05T09:00:02Z",
  "execution_ms": 1840,
  "has_more": false,
  "next_cursor": "",
  "query_id": "01b8c2d4-0306-7a1f-0000-4d5e6f708192",
  "row_count": 1,
  "rows": [
    {
      "dstPort": 22,
      "p_event_time": "2026-11-05 03:31:02.000",
      "srcAddr": "123.123.123.123"
    }
  ],
  "sql": "select p_event_time, srcAddr, dstPort from panther_logs.public.aws_vpcflow where p_occurs_since('1 day') limit 50",
  "started_at": "2026-11-05T09:00:00Z",
  "status": "succeeded",
  "total_rows": 1
}

Run saved query

Run a saved query and wait up to 5 minutes for its rows.

Inputs

Saved querysaved_querytextRequired
The saved query, picked from the list or given as its ID from another step.
Databasedatabasetext
The database the query's tables are in. Leave blank for Panther's logs database, or name each table in full.
Rowsmax_rowsnumber
The most rows to return on one page, up to 999. Defaults to 100.From 1 to 999.

Outputs

bytes_scannednumber
How much data the query scanned, in bytes
columnslist
The columns, in order
completed_attext
When it finished (ISO 8601)
execution_msnumber
How long it ran, in milliseconds
has_moretrue/false
True if there are more rows to fetch
next_cursortext
Give this to 'Get query results' as 'Next page' for more rows; empty on the last page
query_idtext
The query's ID in Panther
row_countnumber
How many rows are on this page
rowslist
The rows on this page, each by column name
sqltext
The SQL that ran
started_attext
When it started (ISO 8601)
statustext
succeeded once it has finished
total_rowsnumber
How many rows the query returned in all
Example output
{
  "bytes_scanned": 1048576,
  "columns": [
    "p_event_time",
    "srcAddr",
    "dstPort"
  ],
  "completed_at": "2026-11-05T09:00:02Z",
  "execution_ms": 1840,
  "has_more": false,
  "next_cursor": "",
  "query_id": "01b8c2d4-0306-7a1f-0000-4d5e6f708192",
  "row_count": 1,
  "rows": [
    {
      "dstPort": 22,
      "p_event_time": "2026-11-05 03:31:02.000",
      "srcAddr": "123.123.123.123"
    }
  ],
  "sql": "select p_event_time, srcAddr, dstPort from panther_logs.public.aws_vpcflow where p_occurs_since('1 day') limit 50",
  "started_at": "2026-11-05T09:00:00Z",
  "status": "succeeded",
  "total_rows": 1
}

Search logs for indicators

Search every log for IP addresses, domains, emails, hashes or other indicators over a period, and wait up to 5 minutes for the matching rows.

Inputs

IndicatorsindicatorslistRequired
The values to look for, such as 203.0.113.24 or an email address.
Indicator typeindicator_typetext
What the values are. Leave blank to let Panther work it out.One of: AutoDetectType (Work it out from each value), p_any_ip_addresses (IP addresses), p_any_domain_names (Domain names), p_any_emails (Email addresses), p_any_usernames (Usernames), p_any_actor_ids (Actor IDs), p_any_md5_hashes (MD5 hashes), p_any_sha1_hashes (SHA-1 hashes), p_any_sha256_hashes (SHA-256 hashes), p_any_aws_account_ids (AWS account IDs), and 8 more.
Fromstart_timedate and time
The start of the period. Leave blank for 7 days before To.
Toend_timedate and time
The end of the period. Leave blank for now.
Rowsmax_rowsnumber
The most rows to return on one page, up to 999. Defaults to 100.From 1 to 999.

Outputs

bytes_scannednumber
How much data the query scanned, in bytes
columnslist
The columns, in order
completed_attext
When it finished (ISO 8601)
execution_msnumber
How long it ran, in milliseconds
has_moretrue/false
True if there are more rows to fetch
next_cursortext
Give this to 'Get query results' as 'Next page' for more rows; empty on the last page
query_idtext
The query's ID in Panther
row_countnumber
How many rows are on this page
rowslist
The rows on this page, each by column name
sqltext
The SQL that ran
started_attext
When it started (ISO 8601)
statustext
succeeded once it has finished
total_rowsnumber
How many rows the query returned in all
Example output
{
  "bytes_scanned": 1048576,
  "columns": [
    "p_event_time",
    "srcAddr",
    "dstPort"
  ],
  "completed_at": "2026-11-05T09:00:02Z",
  "execution_ms": 1840,
  "has_more": false,
  "next_cursor": "",
  "query_id": "01b8c2d4-0306-7a1f-0000-4d5e6f708192",
  "row_count": 1,
  "rows": [
    {
      "dstPort": 22,
      "p_event_time": "2026-11-05 03:31:02.000",
      "srcAddr": "123.123.123.123"
    }
  ],
  "sql": "select p_event_time, srcAddr, dstPort from panther_logs.public.aws_vpcflow where p_occurs_since('1 day') limit 50",
  "started_at": "2026-11-05T09:00:00Z",
  "status": "succeeded",
  "total_rows": 1
}

Start query

Start a SQL query over your logs and carry on at once. Give its query ID to 'Get query results' for the rows.

Inputs

SQLsqltextRequired
The SQL to run over your logs, such as select * from panther_logs.public.aws_cloudtrail where p_occurs_since('1 day') limit 100.
Databasedatabasetext
The database the query's tables are in. Leave blank for Panther's logs database, or name each table in full.

Outputs

databasetext
The database it runs against; empty for Panther's default
query_idtext
The query's ID; give it to 'Get query results'
sqltext
The SQL it runs
statustext
running
Example output
{
  "database": "",
  "query_id": "01b8c2d4-0306-7a1f-0000-4d5e6f708192",
  "sql": "select p_event_time, srcAddr, dstPort from panther_logs.public.aws_vpcflow where p_occurs_since('1 day') limit 50",
  "status": "running"
}

Turn detection on or off

Turn a detection on or off. Everything else about it stays as it is; a detection already that way is left alone.

Inputs

Detection typedetection_typetext
What kind of detection it is. Leave blank for a rule.One of: rule, scheduled_rule (Scheduled rule), simple_rule (Simple rule), correlation_rule (Correlation rule), policy.
DetectiondetectiontextRequired
The detection, picked from the list or typed as its ID, such as AWS.CloudTrail.Created.
On or offstatetextRequired
Whether the detection should run.One of: enabled (On), disabled (Off).

Outputs

changedtrue/false
True if it was switched; false if it was already that way
created_attext
When it was created (ISO 8601)
dedup_minutesnumber
For how many minutes matching events join one alert
descriptiontext
What it looks for
enabledtrue/false
True if it's on
idtext
The detection's ID
last_modifiedtext
When it last changed (ISO 8601)
log_typeslist
The log types it reads; empty for a policy
managedtrue/false
True if Panther manages it
nametext
Its display name, or its ID if it has none
referencetext
A link or note for more about it
resource_typeslist
For a policy, the cloud resource types it checks
runbooktext
What to do about its alerts
scheduled_querieslist
For a scheduled rule, the saved queries it reads
severitytext
CRITICAL, HIGH, MEDIUM, LOW or INFO
tagslist
Its tags
thresholdnumber
How many events must match before it alerts; 0 if not set
typetext
rule, scheduled_rule, simple_rule, correlation_rule or policy
Example output
{
  "changed": true,
  "created_at": "2026-10-01T09:00:00Z",
  "dedup_minutes": 60,
  "description": "This rule alerts on any activity outside of our IP address allowlist",
  "enabled": false,
  "id": "AllLogs.IPMonitoring",
  "last_modified": "2026-11-01T12:00:00Z",
  "log_types": [
    "AWS.VPCFlow"
  ],
  "managed": false,
  "name": "Monitor Suspicious IPs",
  "reference": "https://docs.panther.com/detections/rules",
  "resource_types": [],
  "runbook": "Check whether the address belongs to a vendor before blocking it.",
  "scheduled_queries": [],
  "severity": "HIGH",
  "tags": [
    "Network Monitoring",
    "Threat Intel"
  ],
  "threshold": 1,
  "type": "rule"
}

Unassign alert

Take an alert's assignee off it, so it shows as unassigned.

Inputs

Alertalert_idtextRequired
The alert's ID, from a Panther trigger or 'List alerts', or a link to the alert in Panther.

Outputs

assignee_emailtext
Their email; empty if unassigned or unknown
assignee_idtext
The ID of the user it's assigned to; empty if unassigned
assignee_nametext
Their name; empty if unassigned or unknown
contextobject
The alert context its detection added, as Panther gives it
context_tagslist
Its context tags
created_attext
When the alert was created (ISO 8601)
detection_idtext
The ID of the detection that raised it
detection_typetext
RULE, SCHEDULED_RULE, CORRELATION_RULE or POLICY
event_countnumber
How many events it has
first_event_attext
When its first event happened (ISO 8601)
idtext
The alert's ID
last_event_attext
When its latest event arrived (ISO 8601)
linktext
A link to the alert in Panther; empty for an instance outside Panther's cloud
qualitytext
USEFUL or NOISE; empty if not rated
runbooktext
What to do about it, from its detection
severitytext
CRITICAL, HIGH, MEDIUM, LOW or INFO
statustext
OPEN, TRIAGED, RESOLVED or CLOSED (shown as Invalid in Panther)
status_labeltext
The status as Panther shows it: Open, Triaged, Resolved or Invalid
system_error_source_idtext
For a system error, the ID of what it's about
system_error_source_typetext
For a system error, what kind of thing that is
system_error_typetext
For a system error, what kind it is
titletext
The alert's title
typetext
What raised it, such as RULE, SCHEDULED_RULE or POLICY
Example output
{
  "assignee_email": "",
  "assignee_id": "",
  "assignee_name": "",
  "context": {
    "ip": "123.123.123.123"
  },
  "context_tags": [],
  "created_at": "2026-11-05T03:35:24Z",
  "detection_id": "AllLogs.IPMonitoring",
  "detection_type": "RULE",
  "event_count": 3,
  "first_event_at": "2026-11-05T03:31:02Z",
  "id": "b90c19e66e160e194a5b3b94ec27fb7c",
  "last_event_at": "2026-11-05T03:35:20Z",
  "link": "https://acme.runpanther.net/alerts/b90c19e66e160e194a5b3b94ec27fb7c",
  "quality": "",
  "runbook": "Check whether the address belongs to a vendor before blocking it.",
  "severity": "HIGH",
  "status": "OPEN",
  "status_label": "Open",
  "system_error_source_id": "",
  "system_error_source_type": "",
  "system_error_type": "",
  "title": "New Alert: Suspicious traffic detected from [123.123.123.123]",
  "type": "RULE"
}

Update alert

Change an alert's status, rate its quality as Useful or Noise, or add context tags. Fields left blank keep what the alert has; tags are added to its own.

Inputs

Alertalert_idtextRequired
The alert's ID, from a Panther trigger or 'List alerts', or a link to the alert in Panther.
Statusstatustext
Its new status. Panther suggests rating a noisy alert Noise rather than marking it Invalid.One of: OPEN, TRIAGED, RESOLVED, CLOSED (Invalid).
Qualityqualitytext
Whether the alert was useful or noise.One of: USEFUL, NOISE.
Add context tagscontext_tagslist
Tags to add, such as known-good. An alert can have up to 10.

Outputs

assignee_emailtext
Their email; empty if unassigned or unknown
assignee_idtext
The ID of the user it's assigned to; empty if unassigned
assignee_nametext
Their name; empty if unassigned or unknown
contextobject
The alert context its detection added, as Panther gives it
context_tagslist
Its context tags
created_attext
When the alert was created (ISO 8601)
detection_idtext
The ID of the detection that raised it
detection_typetext
RULE, SCHEDULED_RULE, CORRELATION_RULE or POLICY
event_countnumber
How many events it has
first_event_attext
When its first event happened (ISO 8601)
idtext
The alert's ID
last_event_attext
When its latest event arrived (ISO 8601)
linktext
A link to the alert in Panther; empty for an instance outside Panther's cloud
qualitytext
USEFUL or NOISE; empty if not rated
runbooktext
What to do about it, from its detection
severitytext
CRITICAL, HIGH, MEDIUM, LOW or INFO
statustext
OPEN, TRIAGED, RESOLVED or CLOSED (shown as Invalid in Panther)
status_labeltext
The status as Panther shows it: Open, Triaged, Resolved or Invalid
system_error_source_idtext
For a system error, the ID of what it's about
system_error_source_typetext
For a system error, what kind of thing that is
system_error_typetext
For a system error, what kind it is
titletext
The alert's title
typetext
What raised it, such as RULE, SCHEDULED_RULE or POLICY
Example output
{
  "assignee_email": "ada@example.com",
  "assignee_id": "8a1d2c0e-5b6f-4a7c-9d8e-0f1a2b3c4d5e",
  "assignee_name": "Ada Lovelace",
  "context": {
    "ip": "123.123.123.123"
  },
  "context_tags": [],
  "created_at": "2026-11-05T03:35:24Z",
  "detection_id": "AllLogs.IPMonitoring",
  "detection_type": "RULE",
  "event_count": 3,
  "first_event_at": "2026-11-05T03:31:02Z",
  "id": "b90c19e66e160e194a5b3b94ec27fb7c",
  "last_event_at": "2026-11-05T03:35:20Z",
  "link": "https://acme.runpanther.net/alerts/b90c19e66e160e194a5b3b94ec27fb7c",
  "quality": "",
  "runbook": "Check whether the address belongs to a vendor before blocking it.",
  "severity": "HIGH",
  "status": "RESOLVED",
  "status_label": "Resolved",
  "system_error_source_id": "",
  "system_error_source_type": "",
  "system_error_type": "",
  "title": "New Alert: Suspicious traffic detected from [123.123.123.123]",
  "type": "RULE"
}

On this page