cloudflare
Version:
The official TypeScript library for the Cloudflare API
93 lines • 3.06 kB
text/typescript
import { APIResource } from "../../../core/resource.mjs";
import { APIPromise } from "../../../core/api-promise.mjs";
import { RequestOptions } from "../../../internal/request-options.mjs";
export declare class BaseRelationships extends APIResource {
static readonly _key: readonly ['cloudforceOne', 'threatEvents', 'relationships'];
/**
* Deprecated; use GET /events/by-id/{event_id}/relationships. Available through
* 2026-11-28.
*
* @deprecated Use GET /events/by-id/{event_id}/relationships before 2026-11-28.
*/
list(eventID: string, params: RelationshipListParams, options?: RequestOptions): APIPromise<RelationshipListResponse>;
}
export declare class Relationships extends BaseRelationships {
}
export type RelationshipListResponse = Array<RelationshipListResponse.RelationshipListResponseItem>;
export declare namespace RelationshipListResponse {
interface RelationshipListResponseItem {
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 RelationshipListParams {
/**
* Path param: Account ID.
*/
account_id: string;
/**
* Query param: The dataset ID to search within.
*/
datasetId: string;
/**
* Query param: The direction to traverse the graph. Defaults to 'both' to search
* all.
*/
direction?: 'ancestors' | 'descendants' | 'both';
/**
* Query param: Whether to include the starting event in the results. Defaults to
* true.
*/
includeParent?: boolean;
/**
* Query param: An optional array of indicator type IDs to filter the results by.
*/
indicatorTypeIds?: Array<string>;
/**
* Query param: The maximum depth to traverse. Defaults to 5.
*/
maxDepth?: number;
/**
* Query param
*/
page?: number;
/**
* Query param
*/
pageSize?: number;
/**
* Query param: An optional array of relationship types to filter by.
*/
relationshipTypes?: string | Array<string>;
}
export declare namespace Relationships {
export { type RelationshipListResponse as RelationshipListResponse, type RelationshipListParams as RelationshipListParams, };
}
//# sourceMappingURL=relationships.d.mts.map