Class AbuseIPDBClient

Index

Constructors

constructor

Methods

blacklist bulkReport check checkBlock clearAddress getConfig report reports

Constructors

constructor

new AbuseIPDBClient(
apiKey: string,
options?: AbuseIPDBClientOptions,
): AbuseIPDBClient
Creates a new AbuseIPDB client, requires an API key from AbuseIPDB's dashboard.
Parameters
- apiKey: string
  AbuseIPDB client API key.
- Optionaloptions: AbuseIPDBClientOptions
  Optional parameters - AbuseIPDBClientOptions
Returns AbuseIPDBClient
- Defined in lib/api.ts:114

Methods

blacklist

blacklist(
options?: BlacklistOptions,
): Promise<ClientResponse<APIBlacklistEndpointResponse>>
Parameters
- Optionaloptions: BlacklistOptions
  Optional parameters - BlacklistOptions
Returns Promise<ClientResponse<APIBlacklistEndpointResponse>>
See
Blacklist API Endpoint
- Defined in lib/api.ts:334

bulkReport

bulkReport(csv: string): Promise<ClientResponse<APIBulkReportEndpointResponse>>
Parameters
- csv: string
  CSV filepath to be sent.
Returns Promise<ClientResponse<APIBulkReportEndpointResponse>>
See
Bulk-Report API Endpoint
- Defined in lib/api.ts:370

check

check(
ipAddress: string,
options?: CheckOptions,
): Promise<ClientResponse<APICheckEndpointResponse>>
Parameters
- ipAddress: string
  Single IPv4/IPv6 address to be verified.
- Optionaloptions: CheckOptions
  Optional parameters - CheckOptions
Returns Promise<ClientResponse<APICheckEndpointResponse>>
See
Check API Endpoint
- Defined in lib/api.ts:307

checkBlock

checkBlock(
network: string,
options?: CheckBlockOptions,
): Promise<ClientResponse<APICheckBlockEndpointResponse>>
Parameters
- network: string
  Single IPv4/IPv6 address block in CIDR format.
- Optionaloptions: CheckBlockOptions
  Optional parameters - CheckBlockOptions
Returns Promise<ClientResponse<APICheckBlockEndpointResponse>>
See
Check-Block API Endpoint
- Defined in lib/api.ts:359

clearAddress

clearAddress(
ipAddress: string,
): Promise<ClientResponse<APIClearAddressEndpointResponse>>
Parameters
- ipAddress: string
  Single IPv4/IPv6 address.
Returns Promise<ClientResponse<APIClearAddressEndpointResponse>>
See
Clear-Address API Endpoint
- Defined in lib/api.ts:380

getConfig

getConfig(): AbuseIPDBClientConfig
Returns the current client config.

Returns AbuseIPDBClientConfig
- Defined in lib/api.ts:132

report

report(
    ip: string,
    categories: ReportCategory[],
    options?: ReportOptions,
): Promise<ClientResponse<APIReportEndpointResponse>>
Parameters
- ip: string
  Single IPv4/IPv6 address to be verified.
- categories: ReportCategory[]
  Array of categories to be reported.
- Optionaloptions: ReportOptions
  Optional parameters - ReportOptions
Returns Promise<ClientResponse<APIReportEndpointResponse>>
See
Report API Endpoint
- Defined in lib/api.ts:346

reports

reports(
ipAddress: string,
options?: ReportsOptions,
): Promise<ClientResponse<APIReportsEndpointResponse>>
Beta
Parameters
- ipAddress: string
  Single IPv4/IPv6 address to be verified.
- Optionaloptions: ReportsOptions
  Optional parameters - ReportsOptions
Returns Promise<ClientResponse<APIReportsEndpointResponse>>
See
Reports API Endpoint
- Defined in lib/api.ts:323

Class AbuseIPDBClient

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns AbuseIPDBClient

Methods

blacklist

Parameters

Returns Promise<ClientResponse<APIBlacklistEndpointResponse>>

See

bulkReport

Parameters

Returns Promise<ClientResponse<APIBulkReportEndpointResponse>>

See

check

Parameters

Returns Promise<ClientResponse<APICheckEndpointResponse>>

See

checkBlock

Parameters

Returns Promise<ClientResponse<APICheckBlockEndpointResponse>>

See

clearAddress

Parameters

Returns Promise<ClientResponse<APIClearAddressEndpointResponse>>

See

getConfig

Returns AbuseIPDBClientConfig

report

Parameters

Returns Promise<ClientResponse<APIReportEndpointResponse>>

See

reports

Parameters

Returns Promise<ClientResponse<APIReportsEndpointResponse>>

See

Settings

On This Page