Dataiku DSS icon

Dataiku DSS

Use the Dataiku DSS API

Actions364

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 Plugin resource and the Upload File to Plugin operation, it allows uploading files to a specified plugin within Dataiku DSS.

Common scenarios where this node is beneficial include automating plugin management tasks such as uploading new or updated files to plugins, managing plugin contents programmatically, or integrating plugin updates into larger automated workflows.

For example, you might use this node to upload a configuration file or a script to a plugin as part of a CI/CD pipeline that manages Dataiku DSS plugins.

Properties

Name Meaning
Plugin ID The unique identifier of the plugin to which the file will be uploaded.
Path The relative path within the plugin where the file should be uploaded.

These properties are required to specify the target plugin and the destination path inside the plugin for the uploaded file.

Output

The node outputs JSON data representing the response from the Dataiku DSS API after attempting the file upload. This typically includes metadata about the uploaded file or confirmation of success.

If the operation involves downloading files (not in this specific Upload File case), the node can output binary data representing the downloaded file content. For the upload operation, the output is JSON confirming the upload status.

Dependencies

  • Requires an active connection to a Dataiku DSS instance.
  • Requires valid API credentials (an API key) for authenticating 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 that the Dataiku DSS API credentials are properly set up in n8n.
  • Required Parameter Errors: The node validates required parameters like Plugin ID and Path. If these are missing, the node will throw errors indicating which parameter is required.
  • API Request Failures: Network issues, incorrect server URLs, or invalid API keys can cause request failures. Verify connectivity and credential correctness.
  • File Handling Issues: When uploading files, ensure the input binary data is correctly provided and accessible by the node.

Links and References


This summary focuses on the "Plugin" resource and the "Upload File to Plugin" operation as requested, based on static analysis of the provided source code and property definitions.

Discussion