Create Environment

Creates a new environment (KNIME, shell, or Docker). Schedules run against an environment, and the same environment can be reused by several schedules.

Options

Body

The JSON request body. Pre-filled with an example which is derived from the schema.

Validate JSON

Checks “Body” against the JSON schema of the API. This happens on demand only, i.e. a failed check does not prevent the node from being executed — ultimately, the API itself decides what it accepts.

Body: Validation

Result of the last “Validate JSON” run, i.e. a confirmation or the list of schema violations. Not saved with the node settings.

Result Format

Specify how the response should be mapped to the table output. The following formats are available:

Structured Table: Returns a parsed table with data split into rows and columns.

• ID: Stringified ObjectId (hexadecimal string with 24 characters). See ObjectId
• Kind: Identifies this object as an environment.
• Description: The environment's name, shown throughout the app.
• Type: Which kind of workload this environment runs: a KNIME workflow, a shell script, or a Docker container.
• Deletable: Whether this environment can be deleted (no schedules reference it).
• Cacheable: Whether runs of this environment can reuse its previous setup instead of starting fresh each time. Always false for KNIME environments pinned to the nightly version, since that build changes too often to reuse safely.
• Latest Run: The most recent run of this environment, or null if it's never been run.
• Token: An opaque value that changes whenever this environment is invalidated (see the invalidate endpoint) — not meaningful on its own.
• Notes: Markdown-formatted notes about the environment.
• Additional Docker Instructions: Additional Dockerfile Instructions.
• Additional Files: Extra files made available in the environment, e.g. supporting data or configuration.
• Created At: When the environment was created.
• Updated At: When the environment was last changed.
• Created By: A NodePit Runner user account.
• Updated By: A NodePit Runner user account.
• Project: Stringified ObjectId (hexadecimal string with 24 characters). See ObjectId
• Tags: Free-form labels for filtering and matching against executor tags.
• Archs: CPU architectures this environment is limited to. Empty means "any". OR-combined against an executor's supportedArchs.
• KNIME Version: The KNIME version to run the workflow with.
• Repositories: Additional KNIME update sites to install extensions from, beyond the default ones.
• IUs: Extensions (features) to install from the configured update sites.
• EPF File: An uploaded .epf preferences file applied on top of the built-in KNIME preferences.
• EPF Rows: Individual preference entries, either used as-is or appended to epfFile.
• JVM Arguments: Custom JVM arguments for launching KNIME, overriding the version's defaults. Only applied when vmargsEnabled is true.
• Use JVM Arguments: Whether vmargs is applied.
• Source: Whether this Docker environment runs an existing image or builds one from an uploaded Dockerfile.
• Always Pull: Always pull the base image before building, even if a local copy is already cached.
• Registry Auths: Credentials for pulling images from private registries, one entry per registry host.
• Image: The Docker image to run.
• Dockerfile: A file belonging to a project — either manually uploaded, or produced automatically as a run's output.
• Build Args: Build-time arguments (--build-arg) passed to the uploaded Dockerfile's build.

Raw Response: Returns the raw response in a single row with the following columns:

• body: Response body
• status: HTTP status code

Views

This node has no views

Workflows

• No workflows found

Links

• No links available

Developers