Class Alerts

Hierarchy (View Summary)

BaseSubObject
- Alerts

Index

Constructors

Properties

Methods

delete deleteById getById pushAlerts search

Constructors

constructor

new Alerts(options: IBaseSubObjectOptions): Alerts
Parameters
- options: IBaseSubObjectOptions
Returns Alerts
Inherited from BaseSubObject.constructor
- Defined in packages/crowdsec-client/lib/types/BaseSubObject.d.ts:7

Properties

`Protected`http

http: AxiosInstance

Methods

delete

delete(
options: APITypes.Alerts.DeleteAlerts.RequestQuery,
): Promise<APITypes.DeleteAlertsResponse>
Parameters
- options: APITypes.Alerts.DeleteAlerts.RequestQuery
Returns Promise<APITypes.DeleteAlertsResponse>
- Defined in packages/crowdsec-client/lib/types/Alerts/Alerts.d.ts:11

deleteById

deleteById(id: string): Promise<APITypes.DeleteAlertsResponse>
Parameters
- id: string
Returns Promise<APITypes.DeleteAlertsResponse>
- Defined in packages/crowdsec-client/lib/types/Alerts/Alerts.d.ts:12

getById

getById(id: string): Promise<APITypes.GetAlertsResponse>
Parameters
- id: string
Returns Promise<APITypes.GetAlertsResponse>
- Defined in packages/crowdsec-client/lib/types/Alerts/Alerts.d.ts:10

pushAlerts

pushAlerts(
datas: APITypes.AddAlertsRequest,
): Promise<APITypes.AddAlertsResponse>
Create Alerts and return the IDs
Parameters
- datas: APITypes.AddAlertsRequest
Returns Promise<APITypes.AddAlertsResponse>
- Defined in packages/crowdsec-client/lib/types/Alerts/Alerts.d.ts:8

search

search(
options?: APITypes.Alerts.SearchAlerts.RequestQuery,
): Promise<APITypes.GetAlertsResponse>
Parameters
- Optionaloptions: APITypes.Alerts.SearchAlerts.RequestQuery
Returns Promise<APITypes.GetAlertsResponse>
- Defined in packages/crowdsec-client/lib/types/Alerts/Alerts.d.ts:9