Dataiku DSS icon

Dataiku DSS

Use the Dataiku DSS API

Actions364

Security → Get Code Env

AI-generated

Overview

This node integrates with the Dataiku DSS API, enabling users to perform a wide range of operations on various Dataiku DSS resources. Specifically for the Security resource and the Get Code Env operation, it retrieves detailed information about a specific code environment in Dataiku DSS.

Common scenarios where this node is beneficial include:

  • Automating management and retrieval of security-related configurations such as code environments.
  • Integrating Dataiku DSS security environment details into workflows for auditing or compliance.
  • Fetching code environment metadata programmatically to use in deployment or monitoring pipelines.

Practical example:

  • You want to retrieve the configuration details of a particular code environment (identified by language and name) in your Dataiku DSS instance to verify its settings before running jobs that depend on it.

Properties

Name Meaning
Env Lang The programming language of the code environment to get (e.g., "python", "r").
Env Name The name identifier of the code environment to retrieve details for.

These properties are required when performing operations related to code environments, including getting, creating, updating, or deleting them.

Output

The output JSON structure contains the response from the Dataiku DSS API corresponding to the requested code environment. This typically includes all descriptive fields of the code environment object, such as its configuration, installed packages, and other metadata.

If the operation involves downloading files (not applicable for Get Code Env), the node outputs binary data representing the downloaded file.

For the Get Code Env operation, the output will be a JSON object describing the code environment.

Example output snippet (conceptual):

{
  "envLang": "python",
  "envName": "my_code_env",
  "packages": [...],
  "configuration": {...},
  "createdAt": "...",
  "updatedAt": "..."
}

Dependencies

  • Requires an active connection to a Dataiku DSS instance.
  • Needs an API key credential for authentication with the Dataiku DSS API.
  • The node expects the Dataiku DSS server URL and user API key to be configured in the credentials.

Troubleshooting

  • Missing Credentials Error: If the node throws an error about missing API credentials, ensure you have configured the Dataiku DSS API credentials correctly in n8n.
  • Required Parameter Errors: The node validates required parameters like Env Lang and Env Name for code environment operations. Missing these will cause errors; provide valid values.
  • API Request Failures: Network issues or incorrect server URLs can cause request failures. Verify connectivity and correct server address.
  • Unexpected Response Format: If the API returns unexpected data or errors, check the Dataiku DSS API documentation and ensure the API version matches the node's expectations.

Links and References

This summary focuses on the Security resource's Get Code Env operation based on the provided source code and property definitions.

Discussion