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 Plugin operation, it allows uploading a plugin file as a ZIP archive to the Dataiku DSS instance and installs it.

Common scenarios where this node is beneficial include automating plugin deployment workflows, integrating plugin management into CI/CD pipelines, or remotely managing plugins in Dataiku DSS projects without manual intervention.

For example, you can use this node to upload a new version of a custom plugin developed externally, triggering its installation automatically within your Dataiku environment.

Properties

Name Meaning
File (data) The plugin file to upload, expected as a binary file (ZIP archive). This is the content of the plugin that will be installed on the Dataiku DSS instance.

Note: The property data corresponds to the file content to upload. It must be provided when performing the "Upload Plugin" operation.

Output

The node outputs an array of items, each containing either:

  • A JSON object parsed from the API response if the response is JSON.
  • Binary data representing the uploaded plugin or downloaded files, prepared for further processing or saving.
  • Text output if the response is plain text.

For the "Upload Plugin" operation specifically, the output will typically be a JSON object indicating the result of the upload and installation process.

Dependencies

  • Requires valid Dataiku DSS API credentials, including:
    • The URL of the Dataiku DSS server.
    • An API key for authentication.
  • The node uses HTTP requests to communicate with the Dataiku DSS REST API.
  • For file uploads, it uses multipart/form-data encoding.
  • The user must configure the node with appropriate credentials before execution.

Troubleshooting

  • Missing Credentials Error: If the node throws an error about missing API credentials, ensure that the Dataiku DSS API credentials are properly configured in n8n.
  • Required Parameter Errors: Many operations require specific parameters such as project keys, plugin IDs, or file paths. Missing these will cause errors. Verify all required fields are filled.
  • File Upload Issues: Ensure the file input is correctly set as binary data in n8n and that the file is a valid ZIP archive.
  • API Errors: If the Dataiku DSS API returns errors, check the error message for details. Common issues include permission problems, invalid plugin format, or network connectivity.
  • Response Parsing Failures: If the node cannot parse the response JSON, verify the API endpoint and request correctness.

Links and References


This summary focuses on the Plugin resource's Upload Plugin operation, describing how the node uploads a plugin ZIP file to Dataiku DSS using the API, the required input properties, output structure, dependencies, and common troubleshooting tips.

Discussion