nodes/generated

Interface N8nNodeParameters

Source
interface N8nNodeParameters {
    additionalFields?: {
        description?: string;
        name?: string;
        versionId?: string;
    };
    additionalOptions?: {
        categories?: (
            | "instance"
            | "database"
            | "credentials"
            | "filesystem"
            | "nodes"
        )[];
        daysAbandonedWorkflow?: number;
    };
    credentialId?: string;
    credentialTypeName?: string;
    data?: string;
    executionId?: string;
    filters?: | {
        status?: "error"
        | "success"
        | "waiting";
        workflowId?: {
            mode: "id" | "list" | "url";
            value: string;
        };
    }
    | {
        activeWorkflows?: boolean;
        excludePinnedData?: boolean;
        name?: string;
        projectId?: string;
        tags?: string;
    };
    limit?: number;
    name?: string;
    operation?: | "create"
    | "get"
    | "getAll"
    | "update"
    | "delete"
    | "getSchema"
    | "generate"
    | "activate"
    | "deactivate"
    | "getVersion";
    options?: { activeWorkflows?: boolean };
    resource?:
        | "workflow"
        | "audit"
        | "credential"
        | "execution";
    returnAll?: boolean;
    versionId?: string;
    workflowId?: {
        mode: "id"
        | "list"
        | "url";
        value: string;
    };
    workflowObject?: string;
}

Properties§

§readonly additionalFields?: { ... }

Default: {}

§readonly additionalOptions?: { ... }

Default: {}

§readonly credentialId?: string
§readonly credentialTypeName?: string

The available types depend on nodes installed on the n8n instance. Some built-in types include e.g. 'githubApi', 'notionApi', and 'slackApi'.

§readonly data?: string

A valid JSON object with properties required for this Credential Type. To see the expected format, you can use 'Get Schema' operation. Type options: {"alwaysOpenEditWindow":true}

§readonly executionId?: string
§readonly filters?:
    | {
        status?: "error"
        | "success"
        | "waiting";
        workflowId?: {
            mode: "id" | "list" | "url";
            value: string;
        };
    }
    | {
        activeWorkflows?: boolean;
        excludePinnedData?: boolean;
        name?: string;
        projectId?: string;
        tags?: string;
    }

Default: {}

§readonly limit?: number

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

§readonly name?: string

Name of the new credential

§readonly operation?:
    | "create"
    | "get"
    | "getAll"
    | "update"
    | "delete"
    | "getSchema"
    | "generate"
    | "activate"
    | "deactivate"
    | "getVersion"

Default: "get"

§readonly options?: { ... }

Default: {}

§readonly resource?: "workflow" | "audit" | "credential" | "execution"

Default: "workflow"

§readonly returnAll?: boolean

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

§readonly versionId?: string

The version ID to retrieve

§readonly workflowId?: { ... }

Workflow to filter the executions by Default: {"mode":"list","value":""}

§readonly workflowObject?: string

A valid JSON object with required fields: 'name', 'nodes', 'connections' and 'settings'. More information can be found in the documentation. Default: "{ "name": "My workflow", "nodes": [], "connections": {}, "settings": {} }" Type options: {"alwaysOpenEditWindow":true}