Interface HeadAlertsParams

interface HeadAlertsParams {
    decision_type?: string;
    has_active_decision?: boolean;
    ip?: string;
    limit?: number;
    origin?: string;
    range?: string;
    scenario?: string;
    scope?: string;
    simulated?: boolean;
    since?: string;
    until?: string;
    value?: string;
}

Properties

decision_type? has_active_decision? ip? limit? origin? range? scenario? scope? simulated? since? until? value?

Properties

Optionaldecision_type

decision_type?: string

restrict results to alerts with decisions matching given type

Optionalhas_active_decision

has_active_decision?: boolean

only return alerts with decisions not expired yet

Optionalip

ip?: string

IP to search for (shorthand for scope=ip&value=)

Optionallimit

limit?: number

number of alerts to return

Optionalorigin

origin?: string

restrict results to this origin (ie. lists,CAPI,cscli)

Optionalrange

range?: string

range to search for (shorthand for scope=range&value=)

Optionalscenario

scenario?: string

show alerts for this scenario

Optionalscope

scope?: string

show alerts for this scope

Optionalsimulated

simulated?: boolean

if set to true, decisions in simulation mode will be returned as well

Optionalsince

since?: string

search alerts newer than delay (format must be compatible with time.ParseDuration)

Format

date-time

Optionaluntil

until?: string

search alerts older than delay (format must be compatible with time.ParseDuration)

Format

date-time

Optionalvalue

value?: string

show alerts for this value (used with scope)

Settings

Member Visibility

On This Page

Properties