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 Dataiku DSS resources directly from n8n workflows. It supports managing projects, datasets, plugins, dashboards, machine learning models, scenarios, and many other Dataiku DSS entities.

The "Install Plugin From Store" operation under the "Plugin" resource allows users to install a plugin from the Dataiku Store into their DSS instance. This is useful for automating plugin installation as part of deployment or setup workflows, ensuring that required plugins are available without manual intervention.

Practical examples:

  • Automatically install a new plugin from the store when setting up a new DSS environment.
  • Integrate plugin installation into CI/CD pipelines for Dataiku projects.
  • Manage plugin lifecycle programmatically by installing or updating plugins via workflow automation.

Properties

Name Meaning
Request Body JSON object containing the request payload to send with the API call.

Note: The "Request Body" property is used to provide any necessary data for the API request, depending on the specific operation.

Output

The node outputs an array of items where each item contains either:

  • A json field with the parsed JSON response from the Dataiku DSS API, representing the result of the requested operation.
  • A binary field if the response is a file download (e.g., plugin zip archive), containing the binary data of the downloaded file.
  • A text field if the response is a plain string that cannot be parsed as JSON.
  • A JSON object with logs in case of log retrieval operations.

The output structure varies depending on the operation but generally reflects the raw API response content.

Dependencies

  • Requires an active connection to a Dataiku DSS instance.
  • Needs credentials providing the DSS server URL and a valid API key for authentication.
  • Uses HTTP requests to communicate with the DSS REST API.
  • For operations involving file uploads/downloads, it handles multipart form-data and binary data accordingly.

Troubleshooting

  • Missing Credentials: The node will throw an error if the required API credentials are not provided.
  • Required Parameters Missing: Many operations require specific parameters (e.g., project key, plugin ID). If these are missing, the node throws descriptive errors indicating which parameter is required.
  • API Errors: If the DSS API returns an error, the node wraps it and provides the message and stack trace for debugging.
  • Binary Data Handling: For file downloads, ensure the node's output is handled correctly downstream to avoid data corruption.
  • Unsupported Operations: If an unknown resource or operation is specified, the node throws an error indicating the unknown resource.

Links and References


This summary focuses on the "Plugin" resource and specifically the "Install Plugin From Store" operation, describing its purpose, input, output, dependencies, and common troubleshooting points based on static analysis of the provided source code and properties.

Discussion