cloudflare/resources/cloudforce-one/threat-events/attackers.d.ts

The official TypeScript library for the Cloudflare API

import { APIResource } from "../../../core/resource.js";
import { APIPromise } from "../../../core/api-promise.js";
import { RequestOptions } from "../../../internal/request-options.js";
export declare class BaseAttackers extends APIResource {
    static readonly _key: readonly ['cloudforceOne', 'threatEvents', 'attackers'];
    /**
     * Lists known threat attackers tracked in Cloudforce One threat intelligence.
     *
     * @example
     * ```ts
     * const attackers =
     *   await client.cloudforceOne.threatEvents.attackers.list({
     *     account_id: 'account_id',
     *   });
     * ```
     */
    list(params: AttackerListParams, options?: RequestOptions): APIPromise<AttackerListResponse>;
}
export declare class Attackers extends BaseAttackers {
}
export interface AttackerListResponse {
    items: AttackerListResponse.Items;
    type: string;
}
export declare namespace AttackerListResponse {
    interface Items {
        type: string;
    }
}
export interface AttackerListParams {
    /**
     * Path param: Account ID.
     */
    account_id: string;
    /**
     * Query param: Array of dataset IDs to query attackers from. If not provided, uses
     * the default dataset.
     */
    datasetIds?: Array<string>;
}
export declare namespace Attackers {
    export { type AttackerListResponse as AttackerListResponse, type AttackerListParams as AttackerListParams };
}
//# sourceMappingURL=attackers.d.ts.map