cloudflare
Version:
The official TypeScript library for the Cloudflare API
66 lines • 1.93 kB
TypeScript
import { APIResource } from "../../../../core/resource.js";
import { APIPromise } from "../../../../core/api-promise.js";
import { RequestOptions } from "../../../../internal/request-options.js";
export declare class BaseEvents extends APIResource {
static readonly _key: readonly ['cloudforceOne', 'threatEvents', 'datasets', 'events'];
/**
* Retrieves a specific event by its UUID.
*
* @example
* ```ts
* const event =
* await client.cloudforceOne.threatEvents.datasets.events.get(
* 'event_id',
* { account_id: 'account_id', dataset_id: 'dataset_id' },
* );
* ```
*/
get(eventID: string, params: EventGetParams, options?: RequestOptions): APIPromise<EventGetResponse>;
}
export declare class Events extends BaseEvents {
}
export interface EventGetResponse {
attacker: string;
attackerCountry: string;
attackerCountryAlpha3: string;
category: string;
datasetId: string;
date: string;
event: string;
hasChildren: boolean;
indicator: string;
indicatorType: string;
indicatorTypeId: number;
killChain: number;
mitreAttack: Array<string>;
mitreCapec: Array<string>;
numReferenced: number;
numReferences: number;
rawId: string;
referenced: Array<string>;
referencedIds: Array<number>;
references: Array<string>;
referencesIds: Array<number>;
tags: Array<string>;
targetCountry: string;
targetCountryAlpha3: string;
targetIndustry: string;
tlp: string;
uuid: string;
insight?: string;
releasabilityId?: string;
}
export interface EventGetParams {
/**
* Account ID.
*/
account_id: string;
/**
* Dataset ID.
*/
dataset_id: string;
}
export declare namespace Events {
export { type EventGetResponse as EventGetResponse, type EventGetParams as EventGetParams };
}
//# sourceMappingURL=events.d.ts.map