UPupguard
threatmonitoring

List threats

Retrieve Threat Monitoring threats for an organization.

Required API key permissions: BreachRisk (select when creating API key in Account Settings)

get/threatmonitoring/threat/list

Request

Query parameters

module'dark_web' | 'open_web' | 'social_media'

Limit findings to this threat monitoring module.

date_period'last_twenty_four_hours' | 'last_seven_days' | 'last_thirty_days' | 'last_three_months' | 'last_six_months' | 'last_twelve_months' | 'all_time'

The period within which results have been detected.

date_period_timezonestring

The timezone for DatePeriod as per the IANA Time Zone database. Default is UTC.

date_field'date_occurred' | 'date_detected' | 'date_alerted' | 'date_updated' | 'date_closed'

The date the DatePeriod filter applies to. If omitted, the ThreatStatus feed's default date is used. Threats with no value for the selected field are omitted from results.

transformsstring[]

A list of matching transforms to filter results by. Repeat the parameter to supply multiple values.

severitiesstring[]

A list of matching severities to filter results by. Repeat the parameter to supply multiple values.

threat_typesstring[]

A list of matching threat types to filter results by. Repeat the parameter to supply multiple values.

source_typesstring[]

A list of matching source types to filter results by. Repeat the parameter to supply multiple values.

auto_dismissedboolean

Limits threats to those auto-dismissed by an AI analyst

closed_statusstring[]

Limits the set of threat results to those with a remediation status matching at least one entry provided. Repeat the parameter to supply multiple values.

threat_status'open' | 'investigating' | 'remediating' | 'closed'

Limits the set of threat results based on their current status

page_sizeinteger

The page size of results to return. If not supplied, default is 50.

page_tokenstring

The next_page_token from a previous request, use this to get the next page of results.

include_snippetsboolean

Include the text snippet in results. Defaults to false.

sort_bystring[]

Field to sort threats by, with optional :asc or :desc suffix. The direction is ascending when no suffix is given. Allowed fields: date_alerted.

Response

A list of threats

next_page_tokenstring

Example response

{
  "results": [
    {
      "date_alerted": "2006-01-02T15:04:05.999999Z",
      "date_closed": "2006-01-02T15:04:05.999999Z",
      "date_detected": "2006-01-02T15:04:05.999999Z",
      "date_occurred": "2006-01-02T15:04:05.999999Z",
      "date_updated": "2006-01-02T15:04:05.999999Z",
      "dismissed_at": "2006-01-02T15:04:05.999999Z",
      "remediated_at": "2006-01-02T15:04:05.999999Z",
      "remediation_request_last_updated_at": "2006-01-02T15:04:05.999999Z"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.