nodes/generated

Interface TheHiveNodeParameters

Source
interface TheHiveNodeParameters {
    additionalFields?:
        | {
            caseTemplate?: string;
            customFieldsJson?: string;
            customFieldsUi?: {
                customFields: { field?: string; value?: string }[];
            };
        }
        | { caseTemplate?: string };
    analyzers?: unknown[];
    artifactUi?: {
        artifactValues: {
            binaryProperty?: string;
            data?: string;
            dataType?: string;
            message?: string;
            tags?: string;
        }[];
    };
    binaryProperty?: string;
    caseId?: string;
    data?: string;
    dataType?: string;
    date?: string;
    description?: string;
    filters?: | {
        customFieldsUi?: {
            customFields: { field?: string; value?: string }[];
        };
        description?: string;
        follow?: boolean;
        severity?: 1
        | 3
        | 2;
        tags?: string;
        title?: string;
        tlp?: 0 | 1 | 3 | 2;
    }
    | {
        data?: string;
        dataType?: unknown[];
        description?: string;
        ioc?: boolean;
        keyword?: string;
        message?: string;
        range?: {
            dateRange: { fromDate?: string; toDate?: string };
        };
        sighted?: boolean;
        Status?: "Ok"
        | "Deleted";
        tags?: string;
        tlp?: 0 | 1 | 3 | 2;
    }
    | {
        customFieldsUi?: {
            customFields: { field?: string; value?: string }[];
        };
        description?: string;
        endDate?: string;
        flag?: boolean;
        impactStatus?: | "NoImpact"
        | "WithImpact"
        | "NotApplicable";
        owner?: string;
        resolutionStatus?: | "Other"
        | "Duplicated"
        | "Indeterminate"
        | "False Positive"
        | "True Positive";
        severity?: 1
        | 3
        | 2;
        startDate?: string;
        status?: "Open" | "Deleted" | "Resolved";
        summary?: string;
        tags?: string;
        title?: string;
        tlp?: 0 | 1 | 3 | 2;
    }
    | {
        description?: string;
        endDate?: string;
        flag?: boolean;
        owner?: string;
        startDate?: string;
        status?: | "Completed"
        | "Waiting"
        | "InProgress"
        | "Cancel";
        title?: string;
    };
    flag?: boolean;
    follow?: boolean;
    id?: string;
    ioc?: boolean;
    jsonParameters?: boolean;
    limit?: number;
    message?: string;
    operation?: string;
    options?: | { sort?: string }
    | { includeSimilar?: boolean }
    | { tags?: string }
    | {
        customFieldsJson?: string;
        customFieldsUi?: {
            customFields: { field?: string; value?: string }[];
        };
        endDate?: string;
        metrics?: string;
        summary?: string;
    }
    | {
        description?: string;
        endDate?: string;
        owner?: string;
        startDate?: string;
    }
    | {
        attachmentValues?: {
            attachmentValues: { binaryProperty?: string };
        };
    };
    owner?: string;
    resource?: | "task"
    | "case"
    | "log"
    | "alert"
    | "observable";
    responder?: string;
    returnAll?: boolean;
    severity?: 1
    | 3
    | 2;
    sighted?: boolean;
    source?: string;
    sourceRef?: string;
    startDate?: string;
    status?:
        | "Completed"
        | "New"
        | "Updated"
        | "Ignored"
        | "Imported"
        | "Ok"
        | "Deleted"
        | "Waiting"
        | "InProgress"
        | "Cancel";
    tags?: string;
    taskId?: string;
    title?: string;
    tlp?: 0
    | 1
    | 3
    | 2;
    type?: string;
    updateFields?:
        | {
            artifactUi?: {
                artifactValues: {
                    binaryProperty?: string;
                    data?: string;
                    dataType?: string;
                    message?: string;
                    tags?: string;
                }[];
            };
            caseTemplate?: string;
            customFieldsJson?: string;
            customFieldsUi?: {
                customFields: { field?: string; value?: string }[];
            };
            description?: string;
            follow?: boolean;
            severity?: 1
            | 3
            | 2;
            status?: "New" | "Updated" | "Ignored" | "Imported";
            tags?: string;
            title?: string;
            tlp?: 0 | 1 | 3 | 2;
        }
        | {
            ioc?: boolean;
            message?: string;
            sighted?: boolean;
            status?: "Ok"
            | "Deleted";
            tags?: string;
            tlp?: 0 | 1 | 3 | 2;
        }
        | {
            customFieldsJson?: string;
            customFieldsUi?: {
                customFields: { field?: string; value?: string }[];
            };
            description?: string;
            endDate?: string;
            flag?: boolean;
            impactStatus?: | "NoImpact"
            | "WithImpact"
            | "NotApplicable";
            metrics?: string;
            owner?: string;
            resolutionStatus?: | "Other"
            | "Duplicated"
            | "FalsePositive"
            | "Indeterminate"
            | "TruePositive";
            severity?: 1
            | 3
            | 2;
            startDate?: string;
            status?: "Open" | "Deleted" | "Resolved";
            summary?: string;
            tags?: string;
            title?: string;
            tlp?: 0 | 1 | 3 | 2;
        }
        | {
            description?: string;
            endDate?: string;
            flag?: boolean;
            owner?: string;
            startDate?: string;
            status?: | "Completed"
            | "Waiting"
            | "InProgress"
            | "Cancel";
            title?: string;
        };
}

Properties§

Source§

readonly additionalFields?:
    | {
        caseTemplate?: string;
        customFieldsJson?: string;
        customFieldsUi?: {
            customFields: { field?: string; value?: string }[];
        };
    }
    | { caseTemplate?: string }

Default: {}

Source§

readonly analyzers?: unknown[]

Choose from the list, or specify IDs using an expression Default: [] Type options: {"loadOptionsDependsOn":["id","dataType"],"loadOptionsMethod":"loadAnalyzers"}

Source§

readonly artifactUi?: {
    artifactValues: {
        binaryProperty?: string;
        data?: string;
        dataType?: string;
        message?: string;
        tags?: string;
    }[];
}

Artifact attributes Default: {} Type options: {"multipleValues":true}

Source§

readonly binaryProperty?: string

The name of the input binary field that represent the attachment file Default: "data"

Source§

readonly caseId?: string

Source§

readonly data?: string

Source§

readonly dataType?: string

Choose from the list, or specify an ID using an expression Type options: {"loadOptionsMethod":"loadObservableTypes"}

Source§

readonly date?: string

Date and time when the alert was raised default=now

Source§

readonly description?: string

Description of the alert

Source§

readonly filters?:
    | {
        customFieldsUi?: {
            customFields: { field?: string; value?: string }[];
        };
        description?: string;
        follow?: boolean;
        severity?: 1
        | 3
        | 2;
        tags?: string;
        title?: string;
        tlp?: 0 | 1 | 3 | 2;
    }
    | {
        data?: string;
        dataType?: unknown[];
        description?: string;
        ioc?: boolean;
        keyword?: string;
        message?: string;
        range?: {
            dateRange: { fromDate?: string; toDate?: string };
        };
        sighted?: boolean;
        Status?: "Ok"
        | "Deleted";
        tags?: string;
        tlp?: 0 | 1 | 3 | 2;
    }
    | {
        customFieldsUi?: {
            customFields: { field?: string; value?: string }[];
        };
        description?: string;
        endDate?: string;
        flag?: boolean;
        impactStatus?: | "NoImpact"
        | "WithImpact"
        | "NotApplicable";
        owner?: string;
        resolutionStatus?: | "Other"
        | "Duplicated"
        | "Indeterminate"
        | "False Positive"
        | "True Positive";
        severity?: 1
        | 3
        | 2;
        startDate?: string;
        status?: "Open" | "Deleted" | "Resolved";
        summary?: string;
        tags?: string;
        title?: string;
        tlp?: 0 | 1 | 3 | 2;
    }
    | {
        description?: string;
        endDate?: string;
        flag?: boolean;
        owner?: string;
        startDate?: string;
        status?: | "Completed"
        | "Waiting"
        | "InProgress"
        | "Cancel";
        title?: string;
    }

Default: {}

Source§

readonly flag?: boolean

Flag of the case default=false

Source§

readonly follow?: boolean

Whether the alert becomes active when updated default=true Default: true

Source§

readonly id?: string

Title of the alert

Source§

readonly ioc?: boolean

Whether the observable is an IOC (Indicator of compromise)

Source§

readonly jsonParameters?: boolean

Default: true

Source§

readonly limit?: number

Max number of results to return Default: 100 Type options: {"minValue":1,"maxValue":500}

Source§

readonly message?: string

Description of the observable in the context of the case

Source§

readonly operation?: string

Choose from the list, or specify an ID using an expression Default: "create" Type options: {"loadOptionsMethod":"loadAlertOptions"}

Source§

readonly options?:
    | { sort?: string }
    | { includeSimilar?: boolean }
    | { tags?: string }
    | {
        customFieldsJson?: string;
        customFieldsUi?: {
            customFields: { field?: string; value?: string }[];
        };
        endDate?: string;
        metrics?: string;
        summary?: string;
    }
    | {
        description?: string;
        endDate?: string;
        owner?: string;
        startDate?: string;
    }
    | {
        attachmentValues?: {
            attachmentValues: { binaryProperty?: string };
        };
    }

Default: {}

Source§

readonly owner?: string

Source§

readonly resource?: "task" | "case" | "log" | "alert" | "observable"

Default: "alert"

Source§

readonly responder?: string

Choose from the list, or specify an ID using an expression Type options: {"loadOptionsDependsOn":["id"],"loadOptionsMethod":"loadResponders"}

Source§

readonly returnAll?: boolean

Whether to return all results or only up to a given limit

Source§

readonly severity?: 1 | 3 | 2

Severity of the alert. Default=Medium. Default: 2

Source§

readonly sighted?: boolean

Whether sighted previously

Source§

readonly source?: string

Source of the alert

Source§

readonly sourceRef?: string

Source reference of the alert

Source§

readonly startDate?: string

Date and time of the begin of the case default=now

Source§

readonly status?:
    | "Completed"
    | "New"
    | "Updated"
    | "Ignored"
    | "Imported"
    | "Ok"
    | "Deleted"
    | "Waiting"
    | "InProgress"
    | "Cancel"

Status of the alert Default: "New"

Source§

readonly tags?: string

Case Tags

Source§

readonly taskId?: string

ID of the task

Source§

readonly title?: string

Title of the alert

Source§

readonly tlp?: 0 | 1 | 3 | 2

Traffict Light Protocol (TLP). Default=Amber. Default: 2

Source§

readonly type?: string

Type of the alert

Source§

readonly updateFields?:
    | {
        artifactUi?: {
            artifactValues: {
                binaryProperty?: string;
                data?: string;
                dataType?: string;
                message?: string;
                tags?: string;
            }[];
        };
        caseTemplate?: string;
        customFieldsJson?: string;
        customFieldsUi?: {
            customFields: { field?: string; value?: string }[];
        };
        description?: string;
        follow?: boolean;
        severity?: 1
        | 3
        | 2;
        status?: "New" | "Updated" | "Ignored" | "Imported";
        tags?: string;
        title?: string;
        tlp?: 0 | 1 | 3 | 2;
    }
    | {
        ioc?: boolean;
        message?: string;
        sighted?: boolean;
        status?: "Ok"
        | "Deleted";
        tags?: string;
        tlp?: 0 | 1 | 3 | 2;
    }
    | {
        customFieldsJson?: string;
        customFieldsUi?: {
            customFields: { field?: string; value?: string }[];
        };
        description?: string;
        endDate?: string;
        flag?: boolean;
        impactStatus?: | "NoImpact"
        | "WithImpact"
        | "NotApplicable";
        metrics?: string;
        owner?: string;
        resolutionStatus?: | "Other"
        | "Duplicated"
        | "FalsePositive"
        | "Indeterminate"
        | "TruePositive";
        severity?: 1
        | 3
        | 2;
        startDate?: string;
        status?: "Open" | "Deleted" | "Resolved";
        summary?: string;
        tags?: string;
        title?: string;
        tlp?: 0 | 1 | 3 | 2;
    }
    | {
        description?: string;
        endDate?: string;
        flag?: boolean;
        owner?: string;
        startDate?: string;
        status?: | "Completed"
        | "Waiting"
        | "InProgress"
        | "Cancel";
        title?: string;
    }

Default: {}