Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Client

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

  • new Client(configuration: IConfig, baseUrl?: string, http?: { fetch: any }): Client

  • Parameters

    • configuration: IConfig
    • Optional baseUrl: string
    • Optional http: { fetch: any }
      • fetch:function
        • fetch(url: RequestInfo, init?: RequestInit): Promise<Response>

        • Parameters

          • url: RequestInfo
          • Optional init: RequestInit

          Returns Promise<Response>

    Returns Client

Properties

Private baseUrl

baseUrl: any

Private http

http: any

Protected jsonParseReviver

jsonParseReviver: undefined | ((key: string, value: any) => any)

Methods

addComment

  • Add Alert comment

    Parameters

    Returns Promise<boolean>

addComments

  • Add comment to multiple Alerts

    Parameters

    Returns Promise<string[]>

deleteAlerts

  • deleteAlerts(alertIds: string[]): Promise<void>

  • Delete Alert definitions

    Parameters

    • alertIds: string[]

      List of alert definitions IDs

    Returns Promise<void>

    Deletion was successful

deleteComment

  • deleteComment(body: number[]): Promise<boolean>

  • Delete Alert comment

    Parameters

    • body: number[]

      List of ID comments to delete

    Returns Promise<boolean>

get

  • get(id: string, tags: undefined | boolean, annotations: undefined | boolean): Promise<Alert>

  • Get Alert without context

    Parameters

    • id: string

      Alert ID

    • tags: undefined | boolean

      (optional) If the parameter exists and the value is TRUE all the alert tags will be included in the response.

    • annotations: undefined | boolean

      (optional) If the parameter exists and the value is TRUE all the alert annotations will be included in the response.

    Returns Promise<Alert>

getAlerts

  • getAlerts(nameFilter: undefined | string, idFilter: undefined | string, body: undefined | Pageable): Promise<AlertDefinition[]>

  • Get Alert definitions

    Parameters

    • nameFilter: undefined | string

      (optional) Alert name to filter

    • idFilter: undefined | string

      (optional) Alert id to filter

    • body: undefined | Pageable

      (optional)

    Returns Promise<AlertDefinition[]>

getList

  • Get all Alert comments

    Parameters

    • body: number[]

      Alert ID lists

    Returns Promise<AlertComments[]>

getListByCriterias

  • getListByCriterias(limit: string, offset: string, from: string, to: string, orderby: undefined | string, orderasc: undefined | boolean, showAll: undefined | boolean): Promise<AlertExtended[]>

  • Get Alerts

    Parameters

    • limit: string

      The limit, max number of elements returned

    • offset: string

      The offset, start element in the element number

    • from: string

      The date from in epoch time,with milliseconds obtain from new Date(Long.parseLong(from))

    • to: string

      The date to in epoch time,with milliseconds,obtain from new Date(Long.parseLong(from))

    • orderby: undefined | string

      (optional) Field to order, must be: id, domain, priority, context, category, srcPort, srcIp, srcHost, dstIp, dstPort, dstHost, protocol, username, application, engine, extraData, status, ack_status_date, createDate, updateDate.

    • orderasc: undefined | boolean

      (optional) Order Ascending

    • showAll: undefined | boolean

      (optional) Obtain all (false positive and close status included) Default:False

    Returns Promise<AlertExtended[]>

getListByCriteriasOverview

  • getListByCriteriasOverview(showAll: undefined | boolean): Promise<string>

  • Get Alert Statistics

    deprecated

    Parameters

    • showAll: undefined | boolean

      (optional) Obtain all (false positive and close status included) Default:False

    Returns Promise<string>

getStatistics

  • getStatistics(hours: undefined | number, from: undefined | number, type: undefined | string, filterName: undefined | string, showAll: undefined | boolean): Promise<FunnelStatistics[]>

  • Get Alert statistics

    Parameters

    • hours: undefined | number

      (optional) Hours back to obtain data

    • from: undefined | number

      (optional) From to obtain data

    • type: undefined | string

      (optional) Type of result, may be 'raw', 'funnel, 'list'

    • filterName: undefined | string

      (optional) filter by name context

    • showAll: undefined | boolean

      (optional) Obtain all (false positive and close status included) Default:False

    Returns Promise<FunnelStatistics[]>

listStatus

  • listStatus(from: undefined | string): Promise<string>

  • Get Alert statuses

    Parameters

    • from: undefined | string

      (optional) The date from in epoch time, with miliseconds. Default value 24 hours before petition

    Returns Promise<string>

postAlerts

postAlertsBatch

Protected processAddComment

  • processAddComment(response: Response): Promise<boolean>

  • Parameters

    • response: Response

    Returns Promise<boolean>

Protected processAddComments

  • processAddComments(response: Response): Promise<string[]>

  • Parameters

    • response: Response

    Returns Promise<string[]>

Protected processDeleteAlerts

  • processDeleteAlerts(response: Response): Promise<void>

  • Parameters

    • response: Response

    Returns Promise<void>

Protected processDeleteComment

  • processDeleteComment(response: Response): Promise<boolean>

  • Parameters

    • response: Response

    Returns Promise<boolean>

Protected processGet

  • processGet(response: Response): Promise<Alert>

  • Parameters

    • response: Response

    Returns Promise<Alert>

Protected processGetAlerts

  • Parameters

    • response: Response

    Returns Promise<AlertDefinition[]>

Protected processGetList

  • Parameters

    • response: Response

    Returns Promise<AlertComments[]>

Protected processGetListByCriterias

  • processGetListByCriterias(response: Response): Promise<AlertExtended[]>

  • Parameters

    • response: Response

    Returns Promise<AlertExtended[]>

Protected processGetListByCriteriasOverview

  • processGetListByCriteriasOverview(response: Response): Promise<string>

  • Parameters

    • response: Response

    Returns Promise<string>

Protected processGetStatistics

  • Parameters

    • response: Response

    Returns Promise<FunnelStatistics[]>

Protected processListStatus

  • processListStatus(response: Response): Promise<string>

  • Parameters

    • response: Response

    Returns Promise<string>

Protected processPostAlerts

  • Parameters

    • response: Response

    Returns Promise<AlertDefinition>

Protected processPostAlertsBatch

  • Parameters

    • response: Response

    Returns Promise<AlertDefinition[]>

Protected processPutAlertStatus

  • Parameters

    • response: Response

    Returns Promise<AlertSubscriptionUpdate>

Protected processPutAlerts

  • Parameters

    • response: Response

    Returns Promise<AlertDefinition>

Protected processPutAlertsBatch

  • Parameters

    • response: Response

    Returns Promise<AlertDefinition[]>

Protected processSetTags

  • processSetTags(response: Response): Promise<any>

  • Parameters

    • response: Response

    Returns Promise<any>

Protected processUpdateComment

  • processUpdateComment(response: Response): Promise<boolean>

  • Parameters

    • response: Response

    Returns Promise<boolean>

Protected processUpdateComments

  • processUpdateComments(response: Response): Promise<string>

  • Parameters

    • response: Response

    Returns Promise<string>

Protected processUpdateStatus

  • processUpdateStatus(response: Response): Promise<Alert>

  • Parameters

    • response: Response

    Returns Promise<Alert>

Protected processUpdateStatusLists

  • processUpdateStatusLists(response: Response): Promise<any>

  • Parameters

    • response: Response

    Returns Promise<any>

putAlertStatus

  • Update Alert definition statuses

    Parameters

    • alertIds: string[]

      List of alert definitions IDs

    • enable: boolean

      Enable/disable alert definitions

    Returns Promise<AlertSubscriptionUpdate>

putAlerts

putAlertsBatch

setTags

  • Assign Tag to Alert

    Parameters

    Returns Promise<any>

Protected transformOptions

  • transformOptions(options: RequestInit): Promise<RequestInit>

  • Parameters

    • options: RequestInit

    Returns Promise<RequestInit>

Protected transformResult

  • transformResult(url: string, response: Response, processor: ((response: Response) => any)): any

  • Parameters

    • url: string
    • response: Response
    • processor: ((response: Response) => any)
        • (response: Response): any

        • Parameters

          • response: Response

          Returns any

    Returns any

updateComment

  • Update Alert comment

    Parameters

    Returns Promise<boolean>

updateComments

  • Update bulk Alert comments

    Parameters

    Returns Promise<string>

updateStatus

  • updateStatus(id: string, status: number): Promise<Alert>

  • Update Alert status

    Parameters

    • id: string

      Alert ID

    • status: number

      Alert status with this possible values: UNREAD = 0; UPDATED = 1; FALSE POSTIVE = 2; WATCHED = 100; CLOSED = 300; REMINDER = 500; RECOVERY = 600; ANTI FLOOD = 700;

    Returns Promise<Alert>

updateStatusLists

  • updateStatusLists(status: number, body: undefined | Blob): Promise<any>

  • Update Alert status

    Parameters

    • status: number

      Alert status with this possible values: UNREAD = 0; UPDATED = 1; FALSE POSTIVE = 2; WATCHED = 100; CLOSED = 300; REMINDER = 500; RECOVERY = 600; ANTI FLOOD = 700;

    • body: undefined | Blob

      (optional)

    Returns Promise<any>

Generated using TypeDoc