Interface BitsSecurityAnalystApiListSecurityAgentInvestigationsRequest

Hierarchy

  • BitsSecurityAnalystApiListSecurityAgentInvestigationsRequest

Properties

filterEntity?: string

Only investigations whose signal has all of these entities. Write each entity as attribute:value, matching the values returned by the count endpoint with field=entity. Comma-separated values; an investigation must have every one of them.

filterFrom?: string

Only investigations last updated at or after this time, as RFC 3339 or milliseconds since the epoch.

filterRuleId?: string

Only investigations of signals from one of these detection rule IDs. Comma-separated values; an investigation matches any of them.

filterRuleType?: string

Only investigations of signals from detection rules of one of these types, as returned by the count with field=rule_type. Comma-separated values; an investigation matches any of them.

filterSignalId?: string

List every investigation of this signal, newest first. Accepts the signal ID in its V1 form, which starts with AQ, or in its longer V3 form, which starts with Aw. Investigations carry the V1 form, so their signal_id can differ from the ID you pass. Can't be combined with other filters or with sort.

filterSignalSeverity?: string

Only investigations of signals with one of these severities: info, low, medium, high, or critical. Comma-separated values; an investigation matches any of them.

filterSignalSource?: string

Only investigations of signals from one of these sources, as returned by the count with field=signal_source. Comma-separated values; an investigation matches any of them.

filterState?: string

Only investigations in one of these states: investigating or completed. Investigations reported as failed match investigating. Comma-separated values; an investigation matches any of them.

filterTags?: string

Only investigations whose signal has all of these tags, written key:value. Comma-separated values; an investigation must have every one of them.

filterTitle?: string

Only investigations whose signal title contains this text, case-insensitive.

filterTo?: string

Only investigations last updated at or before this time, as RFC 3339 or milliseconds since the epoch.

filterVerdict?: string

Only investigations with one of these verdicts: benign, suspicious, or malicious. Comma-separated values; an investigation matches any of them.

pageNumber?: number

Page number, starting at 1.

pageSize?: number

Number of investigations per page.

sort?: string

Sort field, prefixed with - for descending: updated_at, severity, verdict, rule_id, or signal_title. Defaults to -updated_at. verdict sorts by severity (benign, suspicious, malicious), so -verdict puts malicious first.

Generated using TypeDoc