Huntress
App · 15 actions
Manage your Huntress organizations and read what Huntress sees: agents, incident reports, signals, escalations, summary and billing reports, identities and who has access to the account.
Actions
| Action | What it does |
|---|---|
| Create organization | Add an organization to the account. |
| Delete organization | Delete an organization. |
| Get account | Get the Huntress account the key belongs to: its name, subdomain, status and which products are on it. |
| Get current user | Get the person who created the API key, and their account. |
| Get organization | Get one organization with its agent and incident counts. |
| List account members | List the people with access to the account and their permission level. |
| List agents | List the computers Huntress protects, filtered by organization, platform or when they were installed or last changed. |
| List billing reports | List the account's billing reports. |
| List escalations | List escalations: issues Huntress's analysts need you to act on. |
| List identities | List the identities (Microsoft 365 and similar users) Huntress protects, optionally for one organization. |
| List incident reports | List incident reports: what Huntress found and what it recommends. |
| List organizations | List the organizations (customers or sites) on the account, with their agent and incident counts. |
| List signals | List signals: suspicious activity Huntress investigated. |
| List summary reports | List the monthly and quarterly summary reports Huntress has made. |
| Update organization | Change an organization's name, key, or the emails notified of incidents and sent reports. |
Create organization
Add an organization to the account. Returns it, with the id later steps use.
Inputs
- Name
nametextRequired - The organization's name, such as the customer or site.
- Organization key
keytextRequired - A short label for the organization that is used when installing agents: letters, digits, '-', '_' or '.'.
Outputs
organizationobject- The organization
Example output
{
"organization": {
"account_id": 68213,
"agents_count": 12,
"billable_identity_count": 0,
"created_at": "2026-11-12T06:20:20Z",
"id": 746528,
"identity_provider_tenant_id": null,
"incident_reports_count": 1,
"key": "acme-corp",
"logs_sources_count": 0,
"microsoft_365_tenant_id": null,
"microsoft_365_users_count": 0,
"name": "Acme Corp",
"notify_emails": [
"it@example.com"
],
"report_recipients": [
"it@example.com"
],
"sat_learner_count": 0,
"updated_at": "2026-11-12T06:20:20Z"
}
}Delete organization
Delete an organization. Its agents and reports go with it, so only use it on one made for testing or closed for good.
Inputs
- Organization
organization_idtextRequired - The organization. Pick one, or give its id from an earlier step.
Outputs
deletedtrue/false- Always true once deleted
organizationobject- The organization as it was deleted
organization_idtext- The organization deleted
Example output
{
"deleted": true,
"organization": {
"account_id": 68213,
"agents_count": 12,
"billable_identity_count": 0,
"created_at": "2026-11-12T06:20:20Z",
"id": 746528,
"identity_provider_tenant_id": null,
"incident_reports_count": 1,
"key": "acme-corp",
"logs_sources_count": 0,
"microsoft_365_tenant_id": null,
"microsoft_365_users_count": 0,
"name": "Acme Corp",
"notify_emails": [
"it@example.com"
],
"report_recipients": [
"it@example.com"
],
"sat_learner_count": 0,
"updated_at": "2026-11-12T06:20:20Z"
},
"organization_id": "746528"
}Get account
Get the Huntress account the key belongs to: its name, subdomain, status and which products are on it.
Inputs
None.
Outputs
accountobject- The account
Example output
{
"account": {
"billing_address": null,
"id": 68213,
"name": "Acme MSP",
"neighborhood_watch": {
"edr": 0,
"itdr": 0
},
"shipping_address": null,
"status": "enabled",
"subdomain": "acme"
}
}Get current user
Get the person who created the API key, and their account.
Inputs
None.
Outputs
accountobject- Their account
userobject- The person the key acts as
Example output
{
"account": {
"id": 68213,
"name": "Acme MSP"
},
"user": {
"email": "jo@example.com",
"id": 201837,
"name": "Jo Bloggs"
}
}Get organization
Get one organization with its agent and incident counts.
Inputs
- Organization
organization_idtextRequired - The organization. Pick one, or give its id from an earlier step.
Outputs
organizationobject- The organization
Example output
{
"organization": {
"account_id": 68213,
"agents_count": 12,
"billable_identity_count": 0,
"created_at": "2026-11-12T06:20:20Z",
"id": 746528,
"identity_provider_tenant_id": null,
"incident_reports_count": 1,
"key": "acme-corp",
"logs_sources_count": 0,
"microsoft_365_tenant_id": null,
"microsoft_365_users_count": 0,
"name": "Acme Corp",
"notify_emails": [
"it@example.com"
],
"report_recipients": [
"it@example.com"
],
"sat_learner_count": 0,
"updated_at": "2026-11-12T06:20:20Z"
}
}List account members
List the people with access to the account and their permission level.
Inputs
- Page
pagenumber - Which page to return, starting at 1. Use 'next_page' from the last result.At least 1.
- Page size
limitnumber - How many to return per page, 1 to 500. Huntress's default is 10.From 1 to 500.
Outputs
countnumber- How many records are on this page
membershipslist- The account's members
next_pagenumber- The page number to ask for next, empty on the last page
pagenumber- This page's number, from 1
total_countnumber- How many records match in all, across every page
Example output
{
"count": 1,
"memberships": [
{
"account": {
"id": 68213,
"name": "Acme MSP"
},
"created_at": "2026-11-12 06:20:20 UTC",
"id": 230665,
"permissions": "Admin",
"updated_at": "2026-11-12 06:20:20 UTC",
"user": {
"email": "jo@example.com",
"id": 201837,
"name": "Jo Bloggs"
}
}
],
"next_page": null,
"page": 1,
"total_count": 1
}List agents
List the computers Huntress protects, filtered by organization, platform or when they were installed or last changed.
Inputs
- Organization
organization_idtext - Only records of this organization. Leave empty for all of them.
- Platform
platformtext - Only computers running this operating system.One of:
windows,darwin(macOS),linux. - Installed since
created_afterdate and time - Only agents installed at or after this time.
- Changed since
updated_afterdate and time - Only agents that changed at or after this time.
- Page
pagenumber - Which page to return, starting at 1. Use 'next_page' from the last result.At least 1.
- Page size
limitnumber - How many to return per page, 1 to 500. Huntress's default is 10.From 1 to 500.
Outputs
agentslist- The agents on this page, as Huntress sends them
countnumber- How many records are on this page
next_pagenumber- The page number to ask for next, empty on the last page
pagenumber- This page's number, from 1
total_countnumber- How many records match in all, across every page
Example output
{
"agents": [
{
"id": 1001
}
],
"count": 1,
"next_page": null,
"page": 1,
"total_count": 1
}List billing reports
List the account's billing reports.
Inputs
- Page
pagenumber - Which page to return, starting at 1. Use 'next_page' from the last result.At least 1.
- Page size
limitnumber - How many to return per page, 1 to 500. Huntress's default is 10.From 1 to 500.
Outputs
billing_reportslist- The billing reports on this page, as Huntress sends them
countnumber- How many records are on this page
next_pagenumber- The page number to ask for next, empty on the last page
pagenumber- This page's number, from 1
total_countnumber- How many records match in all, across every page
Example output
{
"billing_reports": [
{
"id": 1001
}
],
"count": 1,
"next_page": null,
"page": 1,
"total_count": 1
}List escalations
List escalations: issues Huntress's analysts need you to act on.
Inputs
- Organization
organization_idtext - Only records of this organization. Leave empty for all of them.
- Raised since
created_afterdate and time - Only escalations raised at or after this time.
- Page
pagenumber - Which page to return, starting at 1. Use 'next_page' from the last result.At least 1.
- Page size
limitnumber - How many to return per page, 1 to 500. Huntress's default is 10.From 1 to 500.
Outputs
countnumber- How many records are on this page
escalationslist- The escalations on this page, as Huntress sends them
next_pagenumber- The page number to ask for next, empty on the last page
pagenumber- This page's number, from 1
total_countnumber- How many records match in all, across every page
Example output
{
"count": 1,
"escalations": [
{
"id": 1001
}
],
"next_page": null,
"page": 1,
"total_count": 1
}List identities
List the identities (Microsoft 365 and similar users) Huntress protects, optionally for one organization.
Inputs
- Organization
organization_idtext - Only records of this organization. Leave empty for all of them.
- Page
pagenumber - Which page to return, starting at 1. Use 'next_page' from the last result.At least 1.
- Page size
limitnumber - How many to return per page, 1 to 500. Huntress's default is 10.From 1 to 500.
Outputs
countnumber- How many records are on this page
identitieslist- The identities on this page, as Huntress sends them
next_pagenumber- The page number to ask for next, empty on the last page
pagenumber- This page's number, from 1
total_countnumber- How many records match in all, across every page
Example output
{
"count": 1,
"identities": [
{
"id": 1001
}
],
"next_page": null,
"page": 1,
"total_count": 1
}List incident reports
List incident reports: what Huntress found and what it recommends. Filter by organization, status, severity, platform or kind of finding.
Inputs
- Organization
organization_idtext - Only records of this organization. Leave empty for all of them.
- Status
statustext - Only incident reports in this status. Leave empty for all.One of:
sent(Sent (open)),closed,dismissed,partner_dismissed(Dismissed by partner),auto_remediating(Remediating automatically),deleting(Being deleted). - Severity
severitytext - Only incident reports of this severity.One of:
low,high,critical. - Platform
platformtext - Only incident reports from this kind of system.One of:
windows,darwin(macOS),linux,microsoft_365(Microsoft 365),google(Google Workspace),email_security(Email security),other. - What was found
indicator_typetext - Only incident reports of this kind of indicator.One of:
footholds(Persistent footholds),monitored_files(Monitored files),ransomware_canaries(Ransomware canaries),antivirus_detections(Antivirus detections),process_detections(Process detections),managed_identity(Managed identity),mde_detections(Microsoft Defender detections),siem_detections(SIEM detections),favicon_detections(Favicon detections),behavioral_detections(Behavioral detections), and 3 more. - Changed since
updated_afterdate and time - Only incident reports that changed at or after this time.
- Page
pagenumber - Which page to return, starting at 1. Use 'next_page' from the last result.At least 1.
- Page size
limitnumber - How many to return per page, 1 to 500. Huntress's default is 10.From 1 to 500.
Outputs
countnumber- How many records are on this page
incident_reportslist- The incident reports on this page, as Huntress sends them
next_pagenumber- The page number to ask for next, empty on the last page
pagenumber- This page's number, from 1
total_countnumber- How many records match in all, across every page
Example output
{
"count": 1,
"incident_reports": [
{
"id": 1001
}
],
"next_page": null,
"page": 1,
"total_count": 1
}List organizations
List the organizations (customers or sites) on the account, with their agent and incident counts. Filter by exact name or key.
Inputs
- Name
nametext - Only the organization with exactly this name.
- Organization key
keytext - Only the organization with exactly this key.
- Page
pagenumber - Which page to return, starting at 1. Use 'next_page' from the last result.At least 1.
- Page size
limitnumber - How many to return per page, 1 to 500. Huntress's default is 10.From 1 to 500.
Outputs
countnumber- How many records are on this page
next_pagenumber- The page number to ask for next, empty on the last page
organizationslist- The organizations on this page
pagenumber- This page's number, from 1
total_countnumber- How many records match in all, across every page
Example output
{
"count": 1,
"next_page": null,
"organizations": [
{
"account_id": 68213,
"agents_count": 12,
"billable_identity_count": 0,
"created_at": "2026-11-12T06:20:20Z",
"id": 746528,
"identity_provider_tenant_id": null,
"incident_reports_count": 1,
"key": "acme-corp",
"logs_sources_count": 0,
"microsoft_365_tenant_id": null,
"microsoft_365_users_count": 0,
"name": "Acme Corp",
"notify_emails": [
"it@example.com"
],
"report_recipients": [
"it@example.com"
],
"sat_learner_count": 0,
"updated_at": "2026-11-12T06:20:20Z"
}
],
"page": 1,
"total_count": 1
}List signals
List signals: suspicious activity Huntress investigated. Filter by organization, what it is about or the date investigated.
Inputs
- Organization
organization_idtext - Only records of this organization. Leave empty for all of them.
- What it is about
entity_typetext - Only signals about this kind of thing.One of:
agent,identity,user_entity(User),mailbox,service_principal(Service principal),source(Log source). - Investigated on or after
investigated_fromdate - Only signals Huntress investigated on or after this date.
- Investigated on or before
investigated_untildate - Only signals Huntress investigated on or before this date.
- Page
pagenumber - Which page to return, starting at 1. Use 'next_page' from the last result.At least 1.
- Page size
limitnumber - How many to return per page, 1 to 500. Huntress's default is 10.From 1 to 500.
Outputs
countnumber- How many records are on this page
next_pagenumber- The page number to ask for next, empty on the last page
pagenumber- This page's number, from 1
signalslist- The signals on this page, as Huntress sends them
total_countnumber- How many records match in all, across every page
Example output
{
"count": 1,
"next_page": null,
"page": 1,
"signals": [
{
"id": 1001
}
],
"total_count": 1
}List summary reports
List the monthly and quarterly summary reports Huntress has made.
Inputs
- Organization
organization_idtext - Only records of this organization. Leave empty for all of them.
- Report type
report_typetext - Only monthly or only quarterly summaries.One of:
monthly_summary(Monthly summary),quarterly_summary(Quarterly summary). - Period starting on or after
period_fromdate - Only reports for periods starting on or after this date.
- Period ending on or before
period_untildate - Only reports for periods ending on or before this date.
- Page
pagenumber - Which page to return, starting at 1. Use 'next_page' from the last result.At least 1.
- Page size
limitnumber - How many to return per page, 1 to 500. Huntress's default is 10.From 1 to 500.
Outputs
countnumber- How many records are on this page
next_pagenumber- The page number to ask for next, empty on the last page
pagenumber- This page's number, from 1
reportslist- The reports on this page, as Huntress sends them
total_countnumber- How many records match in all, across every page
Example output
{
"count": 1,
"next_page": null,
"page": 1,
"reports": [
{
"id": 1001
}
],
"total_count": 1
}Update organization
Change an organization's name, key, or the emails notified of incidents and sent reports. Only the fields given change.
Inputs
- Organization
organization_idtextRequired - The organization. Pick one, or give its id from an earlier step.
- New name
nametext - Rename the organization. Leave empty to keep its name.
- New organization key
keytext - Change the key. Leave empty to keep it.
- Notification and report emails
report_recipientslist - Who is emailed about incidents and sent the summary reports (Huntress keeps one list for both). This replaces the current list; leave empty to keep it.
Outputs
organizationobject- The organization
Example output
{
"organization": {
"account_id": 68213,
"agents_count": 12,
"billable_identity_count": 0,
"created_at": "2026-11-12T06:20:20Z",
"id": 746528,
"identity_provider_tenant_id": null,
"incident_reports_count": 1,
"key": "acme-corp",
"logs_sources_count": 0,
"microsoft_365_tenant_id": null,
"microsoft_365_users_count": 0,
"name": "Acme Corporation",
"notify_emails": [
"it@example.com"
],
"report_recipients": [
"it@example.com"
],
"sat_learner_count": 0,
"updated_at": "2026-11-12T06:20:20Z"
}
}