Class Allowlists

Hierarchy (View Summary)

BaseSubObject
- Allowlists

Index

Constructors

Properties

Methods

bulkCheck check get list

Constructors

constructor

new Allowlists(options: IBaseSubObjectOptions): Allowlists
Parameters
- options: IBaseSubObjectOptions
Returns Allowlists
Inherited from BaseSubObject.constructor
- Defined in packages/crowdsec-client/src/BaseSubObject.ts:9

Properties

`Protected`http

http: AxiosInstance

Methods

bulkCheck

bulkCheck(targets: string[]): Promise<APITypes.BulkCheckAllowlistResponse>
Parameters
- targets: string[]
Returns Promise<APITypes.BulkCheckAllowlistResponse>
- Defined in packages/crowdsec-client/src/Allowlists/Allowlists.ts:40

check

check(value: string): Promise<APITypes.CheckAllowlistResponse>
Parameters
- value: string
Returns Promise<APITypes.CheckAllowlistResponse>
- Defined in packages/crowdsec-client/src/Allowlists/Allowlists.ts:30

get

get(name: string, withContent?: boolean): Promise<APITypes.GetAllowlistResponse>
Parameters
- name: string
- withContent: boolean = true
Returns Promise<APITypes.GetAllowlistResponse>
- Defined in packages/crowdsec-client/src/Allowlists/Allowlists.ts:18

list

list(withContent?: boolean): Promise<APITypes.GetAllowlistsResponse>
Parameters
- withContent: boolean = true
Returns Promise<APITypes.GetAllowlistsResponse>
- Defined in packages/crowdsec-client/src/Allowlists/Allowlists.ts:6