Interface MispNodeParameters

Source
interface MispNodeParameters {
    additionalFields?:
        | {
            distribution?: 0
            | 1
            | 3
            | 2
            | 4
            | 5;
            sharing_group_id?: string;
        }
        | {
            category?: string;
            deleted?: boolean;
            published?: boolean;
            searchall?: string;
            tags?: string;
            type?: string;
        }
        | {
            analysis?: 0
            | 1
            | 2;
            distribution?: 0 | 1 | 3 | 2 | 4 | 5;
            sharing_group_id?: string;
            threat_level_id?: 1 | 3 | 2 | 4;
        }
        | {
            distribution?: 0
            | 1
            | 3
            | 2
            | 4
            | 5;
            json?: string;
        }
        | {
            created_by_email?: string;
            description?: string;
            nationality?: string;
            sector?: string;
            type?: string;
            usercount?: number;
        }
        | { colour?: string }
        | {
            gpgkey?: string;
            invited_by?: string;
            org_id?: string;
        };
    attributeId?: string;
    email?: string;
    eventId?: string;
    feedId?: string;
    galaxyId?: string;
    information?: string;
    jsonOutput?: string;
    limit?: number;
    name?: string;
    noticelistId?: string;
    operation?: | "create"
    | "get"
    | "getAll"
    | "update"
    | "add"
    | "remove"
    | "delete"
    | "search"
    | "publish"
    | "disable"
    | "enable"
    | "unpublish";
    org_id?: string;
    organisationId?: string;
    provider?: string;
    resource?: | "object"
    | "event"
    | "tag"
    | "feed"
    | "user"
    | "attribute"
    | "eventTag"
    | "galaxy"
    | "noticelist"
    | "organisation"
    | "warninglist";
    returnAll?: boolean;
    role_id?: string;
    tagId?: string;
    type?: "url"
    | "comment"
    | "text";
    updateFields?:
        | {
            distribution?: 0
            | 1
            | 3
            | 2
            | 4
            | 5;
            sharing_group_id?: string;
        }
        | {
            analysis?: 0
            | 1
            | 2;
            distribution?: 0 | 1 | 3 | 2 | 4 | 5;
            information?: string;
            sharing_group_id?: string;
            threat_level_id?: 1 | 3 | 2 | 4;
        }
        | {
            distribution?: 0
            | 1
            | 3
            | 2
            | 4
            | 5;
            name?: string;
            provider?: string;
            rules?: string;
            url?: string;
        }
        | {
            description?: string;
            name?: string;
            nationality?: string;
            sector?: string;
            type?: string;
        }
        | { colour?: string; name?: string }
        | {
            email?: string;
            gpgkey?: string;
            invited_by?: string;
            org_id?: string;
        };
    url?: string;
    useJson?: boolean;
    userId?: string;
    value?: string;
    warninglistId?: string;
}

Properties§

Source§

readonly additionalFields?:
    | {
        distribution?: 0
        | 1
        | 3
        | 2
        | 4
        | 5;
        sharing_group_id?: string;
    }
    | {
        category?: string;
        deleted?: boolean;
        published?: boolean;
        searchall?: string;
        tags?: string;
        type?: string;
    }
    | {
        analysis?: 0
        | 1
        | 2;
        distribution?: 0 | 1 | 3 | 2 | 4 | 5;
        sharing_group_id?: string;
        threat_level_id?: 1 | 3 | 2 | 4;
    }
    | {
        distribution?: 0
        | 1
        | 3
        | 2
        | 4
        | 5;
        json?: string;
    }
    | {
        created_by_email?: string;
        description?: string;
        nationality?: string;
        sector?: string;
        type?: string;
        usercount?: number;
    }
    | { colour?: string }
    | {
        gpgkey?: string;
        invited_by?: string;
        org_id?: string;
    }

Default: {}

Source§

readonly attributeId?: string

UUID or numeric ID of the attribute

Source§

readonly email?: string

Source§

readonly eventId?: string

UUID of the event to attach the attribute to

Source§

readonly feedId?: string

UUID or numeric ID of the feed

Source§

readonly galaxyId?: string

UUID or numeric ID of the galaxy

Source§

readonly information?: string

Information on the event - max 65535 characters

Source§

readonly jsonOutput?: string

Get more info at {YOUR_BASE_URL_SPECIFIED_IN_CREDENTIALS}/api/openapi#operation/restSearchAttributes Default: "{\n "value": "search value",\n "type": "text"\n}\n" Type options: {"rows":5}

Source§

readonly limit?: number

Max number of results to return Default: 50 Type options: {"minValue":1}

Source§

readonly name?: string

Source§

readonly noticelistId?: string

Numeric ID of the noticelist

Source§

readonly operation?:
    | "create"
    | "get"
    | "getAll"
    | "update"
    | "add"
    | "remove"
    | "delete"
    | "search"
    | "publish"
    | "disable"
    | "enable"
    | "unpublish"

Default: "create"

Source§

readonly org_id?: string

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

Source§

readonly organisationId?: string

UUID or numeric ID of the organisation

Source§

readonly provider?: string

Source§

readonly resource?:
    | "object"
    | "event"
    | "tag"
    | "feed"
    | "user"
    | "attribute"
    | "eventTag"
    | "galaxy"
    | "noticelist"
    | "organisation"
    | "warninglist"

Default: "attribute"

Source§

readonly returnAll?: boolean

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

Source§

readonly role_id?: string

Role IDs are available in the MISP dashboard at /roles/index

Source§

readonly tagId?: string

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

Source§

readonly type?: "url" | "comment" | "text"

Default: "text"

Source§

readonly updateFields?:
    | {
        distribution?: 0
        | 1
        | 3
        | 2
        | 4
        | 5;
        sharing_group_id?: string;
    }
    | {
        analysis?: 0
        | 1
        | 2;
        distribution?: 0 | 1 | 3 | 2 | 4 | 5;
        information?: string;
        sharing_group_id?: string;
        threat_level_id?: 1 | 3 | 2 | 4;
    }
    | {
        distribution?: 0
        | 1
        | 3
        | 2
        | 4
        | 5;
        name?: string;
        provider?: string;
        rules?: string;
        url?: string;
    }
    | {
        description?: string;
        name?: string;
        nationality?: string;
        sector?: string;
        type?: string;
    }
    | { colour?: string; name?: string }
    | {
        email?: string;
        gpgkey?: string;
        invited_by?: string;
        org_id?: string;
    }

Default: {}

Source§

readonly url?: string

Source§

readonly useJson?: boolean

Whether to use JSON to specify the fields for the search request

Source§

readonly userId?: string

Numeric ID of the user

Source§

readonly value?: string

Source§

readonly warninglistId?: string

Numeric ID of the warninglist